PHP-Export - index.php

Aus OpenEstate-Wiki

Wechseln zu: Navigation, Suche
Website-Export via ImmoTool
PHP-Export - index.php

Inhaltsverzeichnis

Was macht diese Datei?

Das Skript stellt die Eckdaten der Immobilien in einer Listenansicht dar.

Parameter

Die vom Skript erzeugte Immobilienübersicht kann durch verschiedene Parameter (HTTP-GET) gesteuert werden. Bei Verlinkung / Einbindung des Skriptes in eine Website können die Parameter bei Bedarf vorab gewählt werden.

lang

Durch diesen Parameter wird die dargestellte Sprache gewählt.

  • Erlaubt sind alle Sprachcodes nach ISO-639-1, für die ein Export im ImmoTool gewählt wurde.
  • Wenn keine Sprache gewählt wurde, wird auf die Standardsprache (siehe $DefaultLanguage) zurückgegriffen, die in der config.php hinterlegt wurde.
  • Beispiel zur Darstellung auf englisch:
    index.php?lang=en

page

Wenn sich mehr als 10 Immobilien im Bestand befinden (siehe $ElementsPerPage), werden diese auf mehrere Seiten aufgeteilt. Durch diesen Parameter wird die aktuell dargestellte Seite gewählt.

  • Erlaubt sind ganze Zahlen, größer als 0.
  • Wenn keine Seite gewählt ist, wird die zuletzt verwendete Seitenzahl verwendet.
  • Wenn es keine letzt gewählte Seitenzahl gibt, wird Seite 1 verwendet.
  • Wenn die gewählte Seitenzahl größer als die Zahl der verfügbaren Seiten ist, wird die letzt verfügbare Seite dargestellt.
  • Beispiel zur Darstellung von Seite 2 auf englisch:
    index.php?lang=en&page=2

order

Der Parameter wird verwendet, um Art & Richtung der Sortierung in der Immobilienübersicht anzugeben.

  • Der allgemeine Aufruf einer Sortierung sieht wie folgt aus:
    index.php?order=NAME-DIR
  • An Stelle von NAME muss der interne Name der verwendeten Sortierung angegeben werden.
  • Der Wert von DIR gibt die Richtung der Sortierung an.
    • asc für aufsteigende Sortierung (ascending)
    • desc für absteigende Sortierung (descending)
  • Beispiele
    • Um aufsteigend nach PLZ zu sortieren, lautet der Aufruf:
      index.php?order=postal-asc
    • Um absteigend nach dem Immobilien-Titel zu sortieren, lautet der Aufruf:
      index.php?order=title-desc

filter

Der Parameter wird verwendet, um Filterkriterien auf der Immobilienübersicht anzuwenden.

  • Der allgemeine Aufruf eines Filters sieht wie folgt aus:
    index.php?filter[NAME]=VALUE
  • An Stelle von NAME muss der interne Name des verwendeten Filters angegeben werden.
  • Der Wert von VALUE gibt den zu filternden Wert an.
  • Beispiele
    • Um nach der Vermarktungsart Kauf zu filtern, lautet der Aufruf:
      index.php?filter[action]=kauf
    • Um nach der Immobilienart Wohnung zu filtern, lautet der Aufruf:
      index.php?filter[type]=wohnung
    • Um nach Neubauobjekten zu filtern, lautet der Aufruf:
      index.php?filter[neubau]=1
    • Auch die Kombination mehrerer Filter ist möglich, z.B.
      index.php?filter[type]=wohnung&filter[action]=kauf
  • Ein verwendeter Filter wird dauerhaft in der Sitzung des Anwenders gespeichert! (siehe hier)
    • Um einen Filter wieder zu entfernen, muss dieser explizit deaktiviert werden, mit
      index.php?filter[action]=
    • Alternativ kann der Parameter clearFilters verwendet werden, um zwischengespeicherte Kriterien zu entfernen.

clearFilters

Der Parameter wird verwendet, um die Löschung aller zwischengespeicherten Filterkriterien zu erzwingen.

  • Aufruf:
    index.php?clearFilters=1
  • Um einen bestimmten Filter allein zu erzwingen, ist folgender Aufruf möglich
    index.php?clearFilters=1&filter[action]=kauf

view

Der Parameter steuert den Anzeigemodus der Immobilienübersicht.

  • Wenn view nicht angegeben wurde, wird die Übersicht aller veröffentlichten Immobilien dargestellt.
  • Folgender Aufruf stellt die Vormerkliste des Besuchers dar:
    index.php?view=fav

reset

Sämtliche Auswahlen im Filter-Menü werden aus der Sitzung des Anwenders entfernt.

  • Aufruf:
    index.php?reset=1

Templates

Die Verwendung von Templates wird in diesem Artikel allgemein erläutert.

listing.html

Dieses Template stellt das Grundgerüst der Immobilienübersicht dar.

listing_entry.html

Wenn in der der Immobilienübersicht die tabellarische Ansicht gewählt wurde, wird dieses Templates für jede darzustellende Immobilie geladen und in das Grundgerüst (listing.html) eingefügt.

listing_gallery.html

Wenn in der der Immobilienübersicht die Galerie-Ansicht gewählt wurde, wird dieses Templates für jede darzustellende Immobilie geladen und in das Grundgerüst (listing.html) eingefügt.

Anmerkungen

Parameter werden während der Sitzung gespeichert

Die Parameter lang, page, order & filter werden dauerhaft in der Sitzung des Anwenders gespeichert. Auf diesem Wege bleibt die zuletzt gewählte Seite in der Immobilienübersicht erhalten, auch wenn zwischenzeitig eine Detailansicht geöffnet wurde.

Vormerkliste wird während der Seitzung und als Cookie gespeichert

Die vom Besucher gespeicherte Vormerkliste wird permanent als Cookie gespeichert. Auch wenn der Besucher die Website verlässt und nach mehreren Tagen wieder besucht, ist die Vormerkliste weiterhin vorhanden.

Hinweis: Beachten Sie dabei, dass einige Anwender die Cookies automatisch löschen, nachdem der Browser geschlossen wurde. In diesem Falle ist eine Wiederhestellung der Vormerkliste natürlich nicht möglich.

Persönliche Werkzeuge