• Home
• Immocaster_Immobilienscout_Rest

PHP Class Immocaster_Immobilienscout_Rest

ファイルを表示 Open project: immocaster/php-sdk

Protected Properties

Property	Type	Description
$_bAuthenticateWithoutDB		Authentifizierung standardmäßig mit MySQL Datenbank durchführen false: MySQL, true: Session
$_bRequestDebug	boolean	Rückgabe des Request (False für normalen Request und true für Array mit Infos zum Request. Diese Option sollte nur von Entwicklern für Testzwecke genutzt werden.)
$_sContentRequestType		Anfrageformat: JSON oder standardmäßig XML
$_sContentResultType		Ergebnisformat: JSON oder standardmäßig XML
$_sDefaultUsername		Standard Nutzername für Abfragen per oAuth, wenn ein Nutzername für die Abfrage benötigt wird
$_sProtocol		Requests standardmäßig mit http abgeschickt
$_sProxyName		Proxy
$_sProxyPort
$_sUrlReadingType		Leseprotokoll: standardmäßig cURL Die PHP-Funktion file_get_contents() wird nicht mehr unterstützt.

Public Methods

Method	Description
__call ( string $method, array $args ) : mixed	Magische Funktion welche die Methodenaufrufe in die jeweilige Funktion der Klasse weiterleitet.
__construct ( string $sKey, string $sSecret, string $sAuth ) : void	Der Constructor legt die Einstellungen für die Verbindung fest und startet diese.
_getAllApplicationUsers ( $aArgs ) : array	Alle zertifizierten Benutzernamen auslesen
authenticateWithoutDB ( $bAuthenticateWithoutDB ) : boolean	Authentifizierung ohne MySQL Datenbank aktivieren und deaktivieren.
disableRequestDebug ( ) : boolean	Deaktivieren des Debug-Mode für den Request
enableRequestDebug ( ) : boolean	Aktivieren des Debug-Mode für den Request
getAccess ( array $aArgs ) : mixed	Applikation zeritifizieren.
setContentResultType ( string $sContentResultType = 'none' ) : boolean	Ergebnisformat setzen (z.B. 'none','json').
setProxy ( string $sProxyName, string $sProxyPort = NULL ) : void	Proxy-Einstellungen
setReadingType ( string $sType = 'curl' ) : boolean	Protokoll setzen, wie das Result von der URL gelesen werden soll (z.B. 'none','curl').
setRequestUrl ( string $sUrl ) : boolean	Haupt-URL für Requests zum Service ändern.
setStrictMode ( boolean $bMode = false ) : boolean	Strict-Mode aktivieren und deaktivieren.
useHttps ( $bUseHttps ) : boolean	https / http nutzen

Private Methods

Method	Description
_changeContact ( array $aArgs ) : mixed	Kontaktinformation ändern.
_changeObject ( array $aArgs ) : mixed	Objekt bei ImmobilienScout24 ändern.
_changeObjectAttachment ( array $aArgs ) : mixed	Attachment(Meta)daten ändern Nur Infos über Bild und nicht binären Daten
_changeObjectAttachmentsorder ( array $aArgs ) : mixed	Attachmentsreihenfolge ändern.
_deleteContact ( array $aArgs ) : mixed	Kontakt bei ImmobilienScout24 löschen. Bestehende Immobilienzuordnungen werden durch den Standard Kontakt ersetzt.
_deleteObject ( array $aArgs ) : mixed	Objekt bei ImmobilienScout24 löschen.
_deleteObjectAttachment ( array $aArgs ) : mixed	Anhang zu einem Objekt entfernen.
_deleteallOntopplacement ( array $aArgs ) : mixed	Alle OnTop Platzierungen eines Accounts bei ImmobilienScout24 löschen.
_deletebyidOntopplacement ( array $aArgs ) : mixed	OnTop Platzierung eines Objektes bei ImmobilienScout24 löschen.
_deletebylistOntopplacement ( array $aArgs ) : mixed	Liste von OnTop Platzierung bei ImmobilienScout24 löschen.
_disableObject ( array $aArgs ) : mixed	Objekt bei ImmobilienScout24 deaktivieren.
_enableObject ( array $aArgs ) : mixed	Objekt bei ImmobilienScout24 aktivieren.
_exportContact ( array $aArgs ) : mixed	Kontaktinformation zu ImmobilienScout24 exportieren.
_exportObject ( array $aArgs ) : mixed	Objekt zu ImmobilienScout24 exportieren.
_exportObjectAttachment ( array $aArgs ) : mixed	Anhang zu einem Objekt zu ImmobilienScout24 exportieren.
_exportObjectVideoAttachment ( array $aArgs ) : mixed	StreamingVideo zu einem Objekt zu ImmobilienScout24 exportieren.
_fullUserSearch ( array $aArgs ) : mixed	Abfrage der kompletten Ergebnisliste eines Kunden/Maklers/Börse.
_geoService ( array $aArgs ) : mixed	Der Geo Service der API liefert die Geo-Struktur wieder und liefert zu jedem Ort, zu jeder Stadt, zu jedem Land usw. eine ID anhand der man sich zum kleinsten Punkt (quarter) durchhangeln kann.
_getAttachment ( array $aArgs ) : mixed	Abfrage eines Dateianhangs (Attachment).
_getContact ( array $aArgs ) : mixed	Kontakt eines Users über ContactId abfragen.
_getExpose ( array $aArgs ) : mixed	Abfrage eines Exposes (Search-API) mit der Objekt-ID.
_getExposeImprint ( array $aArgs ) : mixed	Impressum des Angebots anhand einer Objekt-ID auslesen.
_getGeoAutocompletionEntity ( array $aArgs ) : mixed	Abfrage von Geo-Objekten anhand einer Geo-Entity-ID
_getGeoAutocompletionSuggestion ( array $aArgs ) : mixed	Abfrage von Geo-Objekten anhand eines Inputs
_getLogo ( array $aArgs ) : mixed	Logo des Anbieters auslesen.
_getObjectAttachments ( array $aArgs ) : mixed	Alle Anhänge zu einem Objekt per ExportAPI ermitteln.
_getPublish ( array $aArgs ) : mixed	Publishchannels eines Objektes ermitteln (Hierfür müssen besondere Berechtigungen bei ImmobilienScout24 beantragt werden.)
_getPublishChannel ( array $aArgs ) : mixed	Channel ermitteln in dem ein User seine Objekte exportieren darf.
_getUserExpose ( array $aArgs ) : mixed	Abfrage eines eigenen Exposes (Offer-API) mit der Objekt-ID.
_getVideoUploadTicket ( $aArgs )	Video Upload Ticket von IS24 erhalten Man erhält in Response unter anderem videoId und auth Wert
_getallOntopplacement ( array $aArgs ) : mixed	Alle OnTop Platzierungen eines Accounts bei ImmobilienScout24 auslesen.
_getbyidOntopplacement ( array $aArgs ) : mixed	OnTop Platzierung eines Objektes bei ImmobilienScout24 auslesen.
_postVideoToPicsearch ( $aParameter )	Video bei picsearch hochladen 2 Anhänge: auth und das Video an sich
_postbyidOntopplacement ( array $aArgs ) : mixed	Ein Objekt bei ImmobilienScout24 OnTop platzieren.
_postbylistOntopplacement ( array $aArgs ) : mixed	OnTop Platzierungen für mehrere Objekte bei ImmobilienScout24 buchen.
_radiusSearch ( array $aArgs ) : mixed	Abfrage von Ergebnislisten anhand von Geo-Koordinaten und des Objekttyps.
_regionSearch ( array $aArgs ) : mixed	Abfrage von Ergebnislisten anhand der Region-ID und des Objekttyps.
_sendAFriend ( array $aArgs ) : mixed	'Send a friend' für eine Expose (Objekt) mit der Objekt-ID.
_sendContact ( array $aArgs ) : mixed	Kontaktanfrage an den Anbieter eines Exposes (Objekt) mit der Objekt-ID.
doRequest ( string $sPath, array $aArgs, array $aRequired = [], string $sFunctionName, object $oToken = null, boolean $postRequest = FALSE ) : mixed	Ausführen des REST Requests (aus den jeweiligen Funktionen heraus).
getApplicationTokenAndSecret ( $sUser = self::_sDefaultUsername ) : mixed	Application Accesstoken aus der Datenbank holen (3-legged-oauth)
registerAccess ( array $aArgs ) : void	Applikation Accesstoken ermitteln und in Datenbank speichern (3-legged-oauth).
registerRequest ( array $aArgs ) : void	Applikation Requesttoken ermitteln und Benutzer auf SSO weiterleiten.

Method Details

Property Details