PHP-Export - config.php

Aus OpenEstate-Wiki

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

Inhaltsverzeichnis

Was macht diese Datei?

In der Datei config.php können verschiedene allgemeine Einstellungen vorgenommen werden. Die Datei besteht aus drei Klassen.

Änderungen an dieser Datei werden überschrieben!

  • Beim jedem PHP-Export via ImmoTool wird die config.php überschrieben. Die Einstellungen der Export-Schnittstelle werden dabei jedes Mal neu in die config.php eingefügt.
  • Um eine Änderung der Konfiguration dauerhaft zu speichern, verwenden Sie die Datei myconfig.php.

Allgemeine Konfiguration

In der Klasse immotool_setup werden allgemeine Einstellungen hinterlegt. Alle PHP-Skripte können darauf zugreifen.

$DefaultLanguage

Diese Sprache wird beim ersten Aufruf der PHP-Scripte verwendet, wenn keine Sprache vom Anwender gewählt wurde. Erlaubt sind alle Sprachcodes nach ISO-639-1, für die ein Export im ImmoTool gewählt wurde.

  • ab Skript-Version 1.0
  /**
   * Standardmäßig verwendete Sprache.
   * Erlaubt sind ISO-Sprachcodes, für die eine Übersetzung hinterlegt ist.
   * @var string
   */
  var $DefaultLanguage = 'de';

$AdditionalStylesheet

Eine URL zu einer Stylesheet-Datei, die zusätzlich in die erzeugten Seiten eingebunden werden soll.

  • ab Skript-Version 1.0
  /**
   * Zusätzlich verwendeter CSS-Stylesheet.
   * Dies erlaubt Anpassungen am Layout, ohne bestehende Skripte zu ändern.
   * @var string
   */
  var $AdditionalStylesheet = '';

$Timezone

Die gewählte Zeitzone wird für die Darstellung von Datumsangaben verwendet. Verwendet werden können alle von PHP unterstützten Zeitzonen.

  • ab Skript-Version 1.0
  /**
   * Standardmäßig verwendete Zeitzone.
   * Liste der unterstützten Zeitzonen: http://www.php.net/manual/de/timezones.php
   * Wenn keine Zeitzone angegeben wurde, wird die Zeitzone des Servers verwendet.
   * @var string
   */
  var $Timezone = 'Europe/Berlin';

$ShowLanguageSelection

Bei mehrsprachigen Website-Exporten, wird automatisch eine Sprachauswahl erzeugt. Dieser Mechanismus kann bei Bedarf deaktiviert werden, z.B. wenn auf der Website bereits eine Sprachauswahl vorhanden ist.

  • ab Skript-Version 1.1
  /**
   * Sprachauswahl anzeigen.
   * Die automatisch erzeugte Sprachauswahl kann nach Bedarf deaktiviert werden.  
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowLanguageSelection = true;

$Charset

Der für die Ausgabe zu verwendende Zeichensatz kann hier gewählt werden.

  /**
   * Verwendeter Zeichensatz für erzeugte Inhalte.
   * Erzeugte Texte werden vor der Ausgabe ggf. in diesen Zeichensatz umgewandelt.
   * Erlaubt sind die in der PHP-Installation unterstützten Zeichensätze.
   * @var string
   */
  var $Charset = 'UTF-8';

$ContentType

Bei Ausführung der PHP-Skripte wird der zu verwendende Content-Type als HTTP-Header übermittelt.

  • Bei direkter Einbindung in bestehende Webseiten kann dies zu Konflikten führen, wenn z.B. bereits anderweitig ein Content-Type übermittelt wird.
  • Der zu verwendende Content-Type kann nach Bedarf gewählt werden.
  • Sollte kein Content-Type übermittelt werden sollen, kann $ContentType = null; gesetzt werden.
  • ab Skript-Version 1.3
  /**
   * Verwendeter Content-Type für erzeugte Inhalte.
   * Wenn ein Wert angegeben wurde, wird dieser Content-Type als Header in
   * der HTTP-Response dargestellt.
   * @var string
   */
  var $ContentType = 'text/html; charset=UTF-8';

$TemplateFolder

Wenn eigene Anpassungen an den Templates vorgenommen werden sollen, sollte dafür ein neuer Unterordner im templates-Verzeichnis angelegt werden. In den eigenen Template-Ordner können die anzupassenden Standard-Templates aus dem default-Ordner kopiert werden. Damit die Templates aus dem eigenen Template-Ordner (z.B. mytemplates) geladen werden, muss dessen Name in dieser Variablen eingetragen werden, z.B.: $TemplateFolder = 'mytemplates'

  • Wenn ein Template im konfigurierten Template-Unterverzeichnis vorliegt, wird dieses Template zur Darstellung verwendet.
  • Wenn ein Template nicht im konfigurierten Template-Unterverzeichnis vorliegt, wird das Standard-Template aus dem default-Verzeichnis zur Darstellung verwendet.
  • ab Skript-Version 1.5.23 / 1.6.23
  /**
   * Verzeichnis, aus welchem die Templates bevorzugt geladen werden.
   * Der angegebene Name muss als Unterverzeichnis im templates-Verzeichnis
   * vorhanden sein, welches die individuell angepassten Template-Dateien
   * enthält.
   * @var string
   */
  var $TemplateFolder = 'default';

$MailFrom

Diese E-Mailadresse wird als Absender in den versendeten E-Mails verwendet.

  • ab Skript-Version 1.0
  /**
   * Diese E-Mailadresse wird als Absender in den versendeten E-Mails verwendet.
   * @var string
   */
  var $MailFrom = 'max@mustermann.de';

$MailFromName

Diese Name wird als Absender in den versendeten E-Mails verwendet.

  • ab Skript-Version 1.0
  /**
   * Diese Name wird als Absender in den versendeten E-Mails verwendet.
   * @var string
   */
  var $MailFromName = 'Max Mustermann';

$MailToCC

An diese E-Mailadresse wird eine Kopie der versendeten E-Mails versendet. Wenn keine Adresse hinterlegt ist, wird keine Kopie versendet.

  • ab Skript-Version 1.0
  /**
   * An diese E-Mailadresse wird eine Kopie der versendeten E-Mails versendet.
   * Wenn keine Adresse hinterlegt ist, wird keine Kopie versendet.
   * @var string
   */
  var $MailToCC = '';

$MailToBCC

An diese E-Mailadresse wird eine Blindkopie der versendeten E-Mails versendet. Wenn keine Adresse hinterlegt ist, wird keine Blindkopie versendet.

  • ab Skript-Version 1.0
  /**
   * An diese E-Mailadresse wird eine Blindkopie der versendeten E-Mails versendet.
   * Wenn keine Adresse hinterlegt ist, wird keine Blindkopie versendet.
   * @var string
   */
  var $MailToBCC = '';

$MailMethod

Der Mailversand kann auf verschiedene Arten erfolgen.

  • ab Skript-Version 1.0

Folgende Optionen sind möglich:

  • mail
    In diesem Fall wird die E-Mail über die mail-Funktion von PHP versendet. In diesem Falle sind keine weiteren Einstellungen nötig. Jedoch funktioniert dies nicht auf jedem Webspace korrekt.
  • sendmail
    In diesem Fall wird die E-Mail über das Programm sendmail versendet. Auf Linux-Webservern ist dieses Programm normalerweise installiert. Auch diese Variante muss nicht zwingend bei jedem Provider funktionieren.
  • smtp
    In diesem Fall wird die E-Mail über einen SMTP-Server versendet. Wenn die anderen beiden Varianten nicht funktionieren, ist SMTP eine zuverlässige Alternative. Meist wird dafür ein Mailkonto benötigt, entweder auf der eigenen Domain oder von einem externen Anbieter (GMX, Hotmail, Web.de, GMail, etc.).
  • default (ab Skript-Version 1.2)
    In diesem Fall wird die Standard-Einstellung zum Mailtransport beibehalten. Dies kann im Falle von Website-Einbindungen hilfreich sein, wenn dort bereits ein PHPMailer verwendet wird.
  /**
   * Art des Mailversands.
   * mögliche Optionen sind 'default', 'mail', 'sendmail', 'smtp'
   * @var string
   */
  var $MailMethod = 'mail';

$MailSendmailPath

Wenn $MailMethod = 'sendmail' gewählt wurde, kann hier der Pfad zum 'sendmail'-Programm hinterlegt werden. In der Regel muss dies nicht korrigiert werden.

  • ab Skript-Version 1.0
  /**
   * Pfad zum Sendmail-Programm.
   * wenn $MailMethod='sendmail'
   * @var string
   */
  var $MailSendmailPath = '/usr/sbin/sendmail';

$MailSmtpHost

Wenn $MailMethod = 'smtp' gewählt wurde, kann hier der Hostname für den SMTP-Mailversand hinterlegt werden.

  • ab Skript-Version 1.0
  /**
   * Hostname für Mailversand via SMTP.
   * wenn $MailMethod='smtp'
   * @var string
   */
  var $MailSmtpHost = 'localhost';

$MailSmtpPort

Wenn $MailMethod = 'smtp' gewählt wurde, kann hier die Port-Nummer für den SMTP-Mailversand hinterlegt werden.

  • ab Skript-Version 1.0
  /**
   * Port-Nummer für Mailversand via SMTP.
   * wenn $MailMethod='smtp'
   * @var int
   */
  var $MailSmtpPort = 25;

$MailSmtpSecurity

Wenn $MailMethod = 'smtp' gewählt wurde, kann hier eine verschlüsselte SMTP-Übertragung aktiviert werden.

  • ab Skript-Version 1.0
  /**
   * Verschlüsselung des Mailversandes via SMTP.
   * mögliche Optionen sind '', 'ssl', 'tls'
   * wenn $MailMethod='smtp'
   * @var string
   */
  var $MailSmtpSecurity = '';

$MailSmtpAuth

Wenn $MailMethod = 'smtp' gewählt wurde, kann hier die Anmeldung am SMTP-Server aktiviert werden.

  • ab Skript-Version 1.0
  /**
   * Anmeldung am SMTP-Server.
   * wenn $MailMethod='smtp'
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $MailSmtpAuth = false;

$MailSmtpAuthLogin

Wenn $MailMethod = 'smtp' und $MailSmtpAuth = true gewählt wurde, kann hier der Benutzername zur Anmeldung am SMTP-Server hinterlegt werden.

  • ab Skript-Version 1.0
  /**
   * Benutzername zur Anmeldung am SMTP-Server.
   * wenn $MailMethod='smtp' und $MailSmtpAuth=true
   * @var string
   */
  var $MailSmtpAuthLogin = '';

$MailSmtpAuthPassword

Wenn $MailMethod = 'smtp' und $MailSmtpAuth = true gewählt wurde, kann hier das Passwort zur Anmeldung am SMTP-Server hinterlegt werden.

  • ab Skript-Version 1.0
  /**
   * Passwort zur Anmeldung am SMTP-Server.
   * wenn $MailMethod='smtp' und $MailSmtpAuth=true
   * @var string
   */
  var $MailSmtpAuthPassword = '';

$MailSmtpDebug

Wenn $MailMethod = 'smtp' und $MailSmtpAuth = true gewählt wurde, kann hier der Debug-Modus aktiviert werden. Zur weiteren Fehleranalyse werden dabei Übertragungsinformationen ausgegeben.

  • ab Skript-Version 1.0
  /**
   * Den SMTP-Versand im 'debug'-Modus ausführen.
   * Dies kann hilfreich sein, um eventuelle Fehler in der Konfiguration zu finden.
   * wenn $MailMethod='smtp'
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $MailSmtpDebug = false;

$ExposeUrlTemplate

Bei Einbindungen in bestehende Webseiten kann an dieser Stelle eine allgemeine Direkt-URL zu den Exposés hinterlegt werden. Die URL gemäß dieser Vorlage wird in versendeten E-Mails und in erzeugten XML-Feeds verwendet.

  • Die ID der darzustellenden Immobilie wird an Stelle des Platzhalters {ID} eingefügt, z.B.:
    http://www.mustermann-makler.de/immobilien/expose.php?id={ID}
  • Bei Bedarf kann zusätzlich die zu verwendende Sprache mit dem Platzhalter {LANG} eingefügt werden, z.B.:
    http://www.mustermann-makler.de/immobilien/expose.php?id={ID}&lang={LANG}
  • Wenn keine URL-Vorlage hinterlegt ist, wird automatisch ein Link zu expose.php erzeugt.
  • ab Skript-Version 1.5
  /**
   * URL-Vorlage für Exposé-Links.
   * Wird an verschiedenen Stellen verwendet, um Direktlinks auf ein Exposé zu erzeugen
   * Beispiel:
   * $ExposeUrlTemplate = 'http://www.mustermann-makler.de/immobilien/expose.php?id={ID}&lang={LANG}';
   * @var string
   */
  var $ExposeUrlTemplate = null;

$Categories

Für die Erzeugung der Immobilien-Webseiten können Kategorien hinterlegt werden, um unterschiedliche Darstellungen zu ermöglichen.

  • In der Variablen können beliebig viele Kategorien vorgegeben werden.
  • Es ist dabei zu beachten, dass keine Sonderzeichen / Leerzeichen verwendet werden und keine Bezeichnung doppelt verwendet wird.
  • Weitere Informationen zur Verwendung von Kategorien inkl. verschiedener Anwendungs-Szenarien sind in diesem Artikel zusammengefasst.
  • ab Skript-Version 1.5.3
  /**
   * Kategorien.
   * Wird an verschiedenen Stellen verwendet, um unterschiedliches Verhalten für
   * verschiedene Kategorien zu realisieren.
   * Beispiel:
   * $Categories = array( 'wohnen', 'gewerbe', 'anlage' );
   * @var string
   */
  var $Categories = array();

$CacheLifeTime

Während der Ausführung der Skripte werden (aus Gründen besserer Geschwindigkeit) im Cache-Verzeichnis diverse Dateien zwischengespeichert. Nach Ablauf einer bestimmten Lebenszeit werden diese Dateien automatisch gelöscht und neu erzeugt.

  • Die maximale Lebenszeit einer Cache-Datei kann als Zahlenwert in Sekunden angegeben werden.
  • Wird der Zahlenwer '0' eingegeben, findet keine Prüfung auf das Alter einer Cache-Datei statt.
  • ab Skript-Version 1.5.7
  /**
   * Lebensdauer von Cache-Dateien.
   * Eine im Cache-Verzeichnis abgelegte Dateien wird nach einem bestimmten
   * Zeitraum verworfen und neu erzeugt. Die Dauer der Gültigkeit einer
   * Cache-Datei wird in Sekunden erfasst.
   * Beispiel:
   * $CacheLifeTime = 3600; // eine Stunde
   * $CacheLifeTime = 86400; // ein Tag
   * @var int
   */
  var $CacheLifeTime = 10800;

$DynamicImageScaling

An verschiedenen Stellen werden Vorschauen von den Immobilienbildern dargestellt. Die Erzeugung dieser Vorschaubilder kann bei Bedarf von PHP selbst durchgeführt werden. Wenn diese Option aktiviert ist, kann die Größe der erzeugten Vorschaubilder frei konfiguriert werden.

  • Für die automatische Erzeugung von Vorschaubildern muss das GD-Modul von PHP verfügbar sein.
  • ab Skript-Version 1.5.13
  /**
   * Verkleinerte Vorschaubilder dynamisch via PHP erzeugen.
   * Die Option kann nur verwendet werden, wenn das GD-Modul in PHP verfügbar ist.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $DynamicImageScaling = true;

$HandleFavourites

Die Speicherung von Immobilien in einer Vormerkliste kann bei Bedarf aktiviert / deaktiviert werden.

  • ab Skript-Version 1.5.23 / 1.6.23
  /**
   * Vormerkungen von Immobilien aktivieren.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $HandleFavourites = true;

Konfiguration der Immobilienübersicht

Die Klasse immotool_setup_index erweitert immotool_setup um weitere Eigenschaften, die nur für die Immobilienübersicht (index.php) relevant sind.

$ElementsPerPage

Anzahl der Einträge, die auf einer Index-Seite dargestellt werden

  • ab Skript-Version 1.0
  /**
   * Anzahl der Einträge, die auf einer Index-Seite dargestellt werden
   * @var int
   */
  var $ElementsPerPage = 10;

$OrderOptions

Verwendete Sortierungs-Optionen. Es müssen entsprechende Sortierungs-Klassen im Ordner includes der Form class.order_[NAME].php vorliegen.

  • ab Skript-Version 1.0
  /**
   * Verwendete Sortierungs-Optionen.
   * @var array
   */
  var $OrderOptions = array( 'id', 'city', 'postal', 'title', 'price', 'rooms', 'area' );

$DefaultOrderBy

Art der Sortierung beim ersten Besuch der Index-Ansicht. Muss in $OrderOptions enthalten sein.

  • ab Skript-Version 1.0
  /**
   * Art der Sortierung beim ersten Besuch der Index-Ansicht.
   * Muss in $OrderOptions enthalten sein.
   * @var string
   */
  var $DefaultOrderBy = 'id';

$DefaultOrderDir

Richtung der Sortierung beim ersten Besuch der Index-Ansicht.

  • ab Skript-Version 1.0
  /**
   * Richtung der Sortierung beim ersten Besuch der Index-Ansicht.
   * 'asc' für aufsteigend, 'desc' für absteigend
   * @var string
   */
  var $DefaultOrderDir = 'asc';

$DefaultMode

Die Immobilienübersicht standardmäßig als Tabelle oder Galerie darstellen.

  • entry für tabellarische Darstellung der Immobilienübersicht
  • gallery für Galerie-Darstellungen der Immobilienübersicht
  • ab Skript-Version 1.3
  /**
   * Standardmäßig als Tabelle oder Galerie darstellen.
   * 'entry' für tabellarische Darstellung oder
   * 'gallery' für Galerie-Darstellungen
   * @var string
   */
  var $DefaultMode = 'entry';

$FilterOptions

Im Filter-Menü dargestellte Filter-Optionen. Es müssen entsprechende Filter-Klassen im Ordner includes der Form class.filter_[NAME].php vorliegen.

  • ab Skript-Version 1.1
  /**
   * Verwendete Filter-Optionen.
   * @var array
   */
  var $FilterOptions = array( 'action', 'type', 'neubau' );

$FilterAllEstateTypes

Alle verfügbaren Immobilienarten filtern.

  • ab Skript-Version 1.0
  /**
   * Alle verfügbaren Immobilienarten filtern.
   * Wenn aktiviert (true), werden alle verfügbaren Immobilienarten als Filterkriterium dargestellt.
   * Wenn nicht aktiviert (false), werden nur die verfügbaren Haupt-Immobilienarten als Filterkriterium dargestellt.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $FilterAllEstateTypes = true;

$ListingImageSize

Diese Variable definiert die Größe der Vorschaubilder in der Tabellenansicht der Immobilienübersicht.

  • Diese Einstellung wird nur berücksichtigt, wenn
    1. die Option $DynamicImageScaling aktiviert wurde.
    2. das GD-Modul in der PHP-Installation verfügbar ist.
  • Der erste Zahlenwert beschreibt die Breite des Vorschaubildes (in Pixeln).
  • Der zweite Zahlenwert beschreibt die Höhe des Vorschaubildes (in Pixeln).
  • ab Skript-Version 1.5.13
  /**
   * Größe der verkleinerten Vorschaubilder in der Listenansicht der
   * Immobilienübersicht.
   * Die Option kann nur verwendet werden, wenn das GD-Modul in PHP verfügbar ist
   * und '$DynamicImageScaling = true' gesetzt wurde.
   * Die erste Zahl stellt die Breite, die zweite Zahl die Höhe in Pixeln dar.
   * Erlaubt sind ganze Zahlen größer 0.
   * @var array
   */
  var $ListingImageSize = array( 100, 75 );

$GalleryImageSize

Diese Variable definiert die Größe der Vorschaubilder in der Galerieansicht der Immobilienübersicht.

  • Diese Einstellung wird nur berücksichtigt, wenn
    1. die Option $DynamicImageScaling aktiviert wurde.
    2. das GD-Modul in der PHP-Installation verfügbar ist.
  • Der erste Zahlenwert beschreibt die Breite des Vorschaubildes (in Pixeln).
  • Der zweite Zahlenwert beschreibt die Höhe des Vorschaubildes (in Pixeln).
  • ab Skript-Version 1.5.13
  /**
   * Größe der verkleinerten Vorschaubilder in der Galerieansicht der
   * Immobilienübersicht (in Pixel).
   * Die Option kann nur verwendet werden, wenn das GD-Modul in PHP verfügbar ist
   * und '$DynamicImageScaling = true' gesetzt wurde.
   * Die erste Zahl stellt die Breite, die zweite Zahl die Höhe in Pixeln dar.
   * Erlaubt sind ganze Zahlen größer 0.
   * @var array
   */
  var $GalleryImageSize = array( 150, 150 );

$HiddenAttributes

In dieser Variablen können Attribute definiert werden, die grundsätzlich nicht in der Immobilienübersicht dargestellt werden sollen.

  • Für jedes auszuschließende Attribut muss ein Eintrag ins Array eingefügt werden.
  • Ein Eintrag im Array besteht aus dem Gruppen-Namen, gefolt von einem Punkt und gefolgt vom Attribut-Namen.
  • ab Skript-Version 1.5.29
  /**
   * Auflistung von Attributen, die in der Immobilien-Übersicht grundsätzlich
   * nicht dargestellt werden sollen.
   * @var array
   */
  var $HiddenAttributes = array( 'preise.sonderangebot', 'preise.courtage_aussen', 'preise.courtage_aussen_tax' );
  • ab Skript-Version 1.6.29
  /**
   * Auflistung von Attributen, die in der Immobilien-Übersicht grundsätzlich
   * nicht dargestellt werden sollen.
   * @var array
   */
  var $HiddenAttributes = array( 'prices.special_offer', 'prices.agent_fee', 'prices.agent_fee_including_vat' );

Konfiguration der Detailansicht

Die Klasse immotool_setup_expose erweitert immotool_setup um weitere Eigenschaften, die nur für die Detailansicht (expose.php) relevant sind.

$ShowTerms

AGB's im Exposé darstellen.

  • ab Skript-Version 1.0
  /**
   * AGB's im Exposé darstellen.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowTerms = true;

$ShowContactPerson

Kontaktperson im Exposé darstellen.

  • ab Skript-Version 1.0
  /**
   * Kontaktperson im Exposé darstellen.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowContactPerson = true;

$ShowContactForm

Kontaktformular im Exposé darstellen.

  • ab Skript-Version 1.0
  /**
   * Kontaktformular im Exposé darstellen.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowContactForm = true;

$ShowContactCaptcha

Grafischen Bestätigungscode (CAPTCHA) im Exposé-Kontaktformular darstellen.

  • ab Skript-Version 1.0
  /**
   * Grafischen Bestätigungscode (CAPTCHA) im Exposé-Kontaktformular darstellen.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowContactCaptcha = true;

$ShowContactTerms

Text mit rechtlichen Richtlinien im Kontaktformular darstellen und bestätigen lassen.

  • In jeder beliebigen Sprache können Textvorlagen für den Datenschutzhinweis hinterlegt werden. Dafür muss im Ordner 'templates' eine Textdatei hinterlegt werden mit folgender Benennung:
    • templates/expose_contact_terms_bg.txt (bulgarisch)
    • templates/expose_contact_terms_de.txt (deutsch)
    • templates/expose_contact_terms_en.txt (englisch)
    • templates/expose_contact_terms_es.txt (spanisch)
    • templates/expose_contact_terms_it.txt (italienisch)
    • etc.
  • Wenn für eine Sprache keine Textvorlage hinterlegt wurde, wird auf die Datei templates/expose_contact_terms.txt zurückgegriffen.
  • ab Skript-Version 1.5
  /**
   * Text mit rechtlichen Richtlinien im Kontaktformular bestätigen.
   * Erlaubt ist true (=ja) oder false (=nein)
   * @var bool
   */
  var $ShowContactTerms = false;

$ContactRequiredFields

Text mit rechtlichen Richtlinien im Kontaktformular darstellen und bestätigen lassen.

  • Im Array werden die internen Bezeichnungen der Felder angegeben, die als Pflichtfelder bei Kontaktanfragen zu prüfen sind.
  • ab Skript-Version 1.5
  /**
   * Pflichtfelder bei der Verarbeitung des Kontaktformulares.
   * Felder, bei denen die Eingabe keine Pflicht ist, können aus dem Array entfernt werden.
   * @var array
   */
  var $ContactRequiredFields = array( 'name', 'firstname', 'email', 'phone', 'street', 'streetnr', 'city', 'postal', 'message' );

Verwendbar sind folgende internen Bezeichnungen:

interner Name Feld im Formular
name Nachname
firstname Vorname
email E-Mailadresse
phone Telefon-Nummer
street Straße
streetnr Haus-Nummer
city Ort
postal Postleitzahl
message Mitteilung

$GalleryHandler

Einbindung einer externen Bildergalerie.

  • colorbox um Colorbox zur Galerie-Darstellung zu verwenden.
  • lightbox2 um Lightbox2 zur Galerie-Darstellung zu verwenden.
  • html um die Standard-Galerie-Darstellung zu verwenden.
  • ab Skript-Version 1.4
  /**
   * Einbindung einer externen Bildergalerie.
   * @var string
   */
  var $GalleryHandler = 'colorbox';

$MapHandler

Einbindung einer externen Umkreiskarte.

  • osm um OpenStreetMap zur Karten-Darstellung zu verwenden.
  • google um Google Maps zur Karten-Darstellung zu verwenden.
  • ab Skript-Version 1.5.21 / 1.6.21
  /**
   * Einbindung einer Umkreiskarte.
   * @var string
   */
  var $MapHandler = 'osm';

$ViewMode

Die Immobilienansicht aufgeteilt in Reitern oder als Auflistung darstellen.

  • tabular um eine Reiter-Darstellung zu verwenden.
  • listing um eine Auflistung zu verwenden.
  • ab Skript-Version 1.4
  /**
   * Art der Darstellung.
   * Erlaubt ist 'tabular' (=Reiterdarstellung) oder 'listing' (=hintereinander)
   * @var string
   */
  var $ViewMode = 'tabular';

$ViewOrder

Die Reihenfolge der Darstellung in der Exposéansicht kann an dieser Stelle angepasst werden.

  • Die Reihenfolge der Einträge im Array entspricht der Darstellungsreihenfolge in der Exposéansicht.
  • Um bestimmte Elemente nicht darzustellen, kann der zugehörige Eintrag im Array entfernt werden.
  • ab Skript-Version 1.4
  /**
   * Reihenfolge der Darstellung.
   * @var string
   */
  var $ViewOrder = array( 'details', 'texts', 'gallery', 'contact', 'terms' );

$DetailsOrder

Die Reihenfolge der dargestellten Attribut-Gruppen im Reiter 'Details' kann an dieser Stelle angepasst werden.

  • Die Reihenfolge der Einträge im Array entspricht der Darstellungsreihenfolge in der Exposéansicht.
  • Um bestimmte Elemente nicht darzustellen, kann der zugehörige Eintrag im Array entfernt werden.
  • ab Skript-Version 1.5.23
  /**
   * Reihenfolge der dargestellten Attribut-Gruppen im Reiter 'Details'.
   * @var array
   */
  var $DetailsOrder = array( 'preise', 'flaechen', 'ausstattung', 'umfeld', 'zustand', 'verwaltung' );
  • ab Skript-Version 1.6.23
  /**
   * Reihenfolge der dargestellten Attribut-Gruppen im Reiter 'Details'.
   * @var array
   */
  var $DetailsOrder = array( 'prices', 'measures', 'features', 'surroundings', 'condition', 'administration' );

$TextOrder

Die Reihenfolge der dargestellten Beschreibungstexte im Reiter 'Beschreibung' kann an dieser Stelle angepasst werden.

  • Die Reihenfolge der Einträge im Array entspricht der Darstellungsreihenfolge in der Exposéansicht.
  • Um bestimmte Elemente nicht darzustellen, kann der zugehörige Eintrag im Array entfernt werden.
  • ab Skript-Version 1.5.23
  /**
   * Reihenfolge der dargestellten Beschreibungstexte im Reiter 'Beschreibung'.
   * @var array
   */
  var $TextOrder = array( 'objekt_beschr', 'lage_beschr', 'ausstatt_beschr', 'preis_beschr', 'provision_beschr', 'sonstige_angaben', 'kurz_beschr' );
  • ab Skript-Version 1.6.23
  /**
   * Reihenfolge der dargestellten Beschreibungstexte im Reiter 'Beschreibung'.
   * @var array
   */
  var $TextOrder = array( 'detailled_description', 'location_description', 'feature_description', 'price_description', 'agent_fee_information', 'additional_information', 'short_description' );

$TitleImageSize

Diese Variable definiert die Größe des Titelbildes in der Exposéansicht.

  • Diese Einstellung wird nur berücksichtigt, wenn
    1. die Option $DynamicImageScaling aktiviert wurde.
    2. das GD-Modul in der PHP-Installation verfügbar ist.
  • Der erste Zahlenwert beschreibt die Breite des Vorschaubildes (in Pixeln).
  • Der zweite Zahlenwert beschreibt die Höhe des Vorschaubildes (in Pixeln).
  • ab Skript-Version 1.5.13
  /**
   * Größe des verkleinerten Titelbildes in der Exposéansicht (in Pixel).
   * Die Option kann nur verwendet werden, wenn das GD-Modul in PHP verfügbar ist
   * und '$DynamicImageScaling = true' gesetzt wurde.
   * Die erste Zahl stellt die Breite, die zweite Zahl die Höhe in Pixeln dar.
   * Erlaubt sind ganze Zahlen größer 0.
   * @var array
   */
  var $TitleImageSize = array( 200, 150 );

$GalleryImageSize

Diese Variable definiert die Größe der Galeriebilder in der Exposéansicht.

  • Diese Einstellung wird nur berücksichtigt, wenn
    1. die Option $DynamicImageScaling aktiviert wurde.
    2. das GD-Modul in der PHP-Installation verfügbar ist.
  • Der erste Zahlenwert beschreibt die Breite des Vorschaubildes (in Pixeln).
  • Der zweite Zahlenwert beschreibt die Höhe des Vorschaubildes (in Pixeln).
  • ab Skript-Version 1.5.13
  /**
   * Größe der verkleinerten Galeriebilder in der Exposéansicht (in Pixel).
   * Die Option kann nur verwendet werden, wenn das GD-Modul in PHP verfügbar ist
   * und '$DynamicImageScaling = true' gesetzt wurde.
   * Die erste Zahl stellt die Breite, die zweite Zahl die Höhe in Pixeln dar.
   * Erlaubt sind ganze Zahlen größer 0.
   * @var array
   */
  var $GalleryImageSize = array( 100, 75 );

$MetaDescriptionTexts

Diese Variable gibt an, welcher der hinterlegten Beschreibungstext in den Immobilien-Ansichten als "Meta-Description" dargestellt werden sollen.

  • Die hinterlegten Einträge werden nacheinander abgearbeitet. Der erste in der Liste aufgezählte Freitext einer Immobilie wird als "Meta-Description" verwendet.
  • ab Skript-Version 1.5.25
  /**
   * Textfelder, die als META-Description verwendet werden sollen. Das erste
   * Textfeld in der Liste, zu welchem ein Text eingetragen wurde, wird als
   * META-Description in der Exposé-Ansicht dargestellt.
   * @var array
   */
  var $MetaDescriptionTexts = array( 'kurz_beschr', 'objekt_beschr' );
  • ab Skript-Version 1.6.25
  /**
   * Textfelder, die als META-Description verwendet werden sollen. Das erste
   * Textfeld in der Liste, zu welchem ein Text eingetragen wurde, wird als
   * META-Description in der Exposé-Ansicht dargestellt.
   * @var array
   */
  var $MetaDescriptionTexts = array( 'short_description', 'detailled_description' );

$HiddenAttributes

In dieser Variablen können Attribute definiert werden, die grundsätzlich nicht in der Exposé-Ansicht dargestellt werden sollen.

  • Für jedes auszuschließende Attribut muss ein Eintrag ins Array eingefügt werden.
  • Ein Eintrag im Array besteht aus dem Gruppen-Namen, gefolt von einem Punkt und gefolgt vom Attribut-Namen.
  • ab Skript-Version 1.5.29
  /**
   * Auflistung von Attributen, die in der Immobilien-Übersicht grundsätzlich
   * nicht dargestellt werden sollen.
   * @var array
   */
  var $HiddenAttributes = array( 'preise.sonderangebot', 'freitexte.keywords' );
  • ab Skript-Version 1.6.29
  /**
   * Auflistung von Attributen, die in der Immobilien-Übersicht grundsätzlich
   * nicht dargestellt werden sollen.
   * @var array
   */
  var $HiddenAttributes = array( 'prices.special_offer', 'descriptions.keywords' );

Konfiguration des Stylesheets

Die Klasse immotool_setup_style erweitert immotool_setup um weitere Eigenschaften, die nur für die Erzeugung des Stylesheets (style.php) relevant sind.

  • ab Skript-Version 1.2

$ShowGeneralStyles

Um allgemeine Definitionen (body, h1, h2, h3, a ...). im Stylesheet zu erzeugen, kann diese Option aktiviert werden. Bei Einbindung in bestehende Webseiten kann es sinnvoll sein, diese Option zu deaktivieren, um die Standard-Stylesheets der Webseite nicht zu überschreiben.

  • ab Skript-Version 1.2
  /**
   * Allgemeine Stylesheets definieren (body, h1, h2, h3, a ...).
   * @var bool
   */
  var $ShowGeneralStyles = true;

$GeneralTextColor

Allgemeine Farbe für Texte (wenn $ShowGeneralStyles = true).

  • ab Skript-Version 1.2
  /**
   * Allgemein verwendete Textfarbe.
   * wenn $ShowGeneralStyles = true
   * @var string
   */
  var $GeneralTextColor = '#303030';

$GeneralTextFont

Allgemeine Schriftart für Texte (wenn $ShowGeneralStyles = true).

  • ab Skript-Version 1.2
  /**
   * Allgemein verwendete Schriftart.
   * wenn $ShowGeneralStyles = true
   * @var string
   */
  var $GeneralTextFont = 'sans-serif';

$BodyBackgroundColor

Allgemein verwendete Hintergrundfarbe (wenn $ShowGeneralStyles = true).

  • ab Skript-Version 1.2
  /**
   * Allgemein verwendete Hintergrundfarbe.
   * wenn $ShowGeneralStyles = true
   * @var string
   */
  var $BodyBackgroundColor = '#ffffff';

$BodyFontSize

Allgemein verwendete Schriftgröße (wenn $ShowGeneralStyles = true).

  • ab Skript-Version 1.2
  /**
   * Allgemein verwendete Schriftgröße.
   * wenn $ShowGeneralStyles = true
   * @var string
   */
  var $BodyFontSize = '12px';

$LightBackgroundColor

Farbwert für hell hervorgehobene Hintergründe.

  • ab Skript-Version 1.2
  /**
   * Hintergrund, hell.
   * @var string
   */
  var $LightBackgroundColor = '#ffffff';

$DarkBackgroundColor

Farbwert für dunkel hervorgehobene Hintergründe.

  • ab Skript-Version 1.2
  /**
   * Hintergrund, dunkel.
   * @var string
   */
  var $DarkBackgroundColor = '#e6ffe6';

$BorderColor

Farbwert für Umrahmungen.

  • ab Skript-Version 1.2
  /**
   * Farbwert für Umrandungen / Rahmen.
   * @var string
   */
  var $BorderColor = '#6c6';

Konfiguration der XML-Feeds

Die Klasse immotool_setup_feeds erweitert immotool_setup um weitere Eigenschaften, die nur für die erzeugten XML-Feeds (RSS, Atom, Immobiliare, Trovit) relevant sind.

$PublishAtomFeed

Diese Option muss aktiviert werden, damit via feed_atom.php ein Atom XML-Feed erzeugt werden kann.

  • ab Skript-Version 1.5
  /**
   * Atom-Feed veröffentlichen.
   * @var bool
   */
  var $PublishAtomFeed = true;

$PublishRssFeed

Diese Option muss aktiviert werden, damit via feed_rss.php ein RSS XML-Feed erzeugt werden kann.

  • ab Skript-Version 1.5
  /**
   * RSS-Feed veröffentlichen.
   * @var bool
   */
  var $PublishRssFeed = true;

$PublishTrovitFeed

Diese Option muss aktiviert werden, damit via feed_trovit.php ein Trovit XML-Feed erzeugt werden kann.

  • ab Skript-Version 1.5
  /**
   * Trovit-Feed veröffentlichen.
   * @var bool
   */
  var $PublishTrovitFeed = true;

$AtomFeedLimit

Maximale Anzahl von Einträgen im Atom XML-Feed.

  • ab Skript-Version 1.5
  /**
   * Anzahl maximaler Einträge im Atom-Feed.
   * Zur unlimitierten Darstellung: $AtomFeedLimit = null;
   * @var int
   */
  var $AtomFeedLimit = 15;

$AtomFeedWithImage

Darstellung der Titelbilder im im Atom XML-Feed aktivieren / deaktivieren.

  • ab Skript-Version 1.5.22 / 1.6.22
  /**
   * Titelbild der Immobilie im Atom-Feed anzeigen.
   * @var bool
   */
  var $AtomFeedWithImage = true;

$RssFeedLimit

Maximale Anzahl von Einträgen im RSS XML-Feed.

  • ab Skript-Version 1.5
  /**
   * Anzahl maximaler Einträge im RSS-Feed.
   * Zur unlimitierten Darstellung: $RssFeedLimit = null;
   * @var int
   */
  var $RssFeedLimit = 15;

$RssFeedWithImage

Darstellung der Titelbilder im im RSS XML-Feed aktivieren / deaktivieren.

  • ab Skript-Version 1.5.22 / 1.6.22
  /**
   * Titelbild der Immobilie im RSS-Feed anzeigen.
   * @var bool
   */
  var $RssFeedWithImage = true;

$ExportPublicId

Objekt-Nummer an Stelle der Objekt-ID bei Feed-Exporten veröffentlichen.

  • ab Skript-Version 1.5
  /**
   * Objekt-Nummer an Stelle der Objekt-ID bei Feed-Exporten veröffentlichen.
   * @var bool
   */
  var $ExportPublicId = false;

$OrderBy

Art der Sortierung in den erzeugten Feeds.

  • ab Skript-Version 1.5.16
  /**
   * Art der Sortierung in den erzeugten Feeds.
   * @var string
   */
  var $OrderBy = null;

$OrderDir

Richtung der Sortierung in den erzeugten Feeds.

  • ab Skript-Version 1.5.16
  /**
   * Richtung der Sortierung in den erzeugten Feeds.
   * 'asc' für aufsteigend, 'desc' für absteigend
   * @var string
   */
  var $OrderDir = null;
Persönliche Werkzeuge