PHP-Wrapper - CMS made simple

Aus OpenEstate-Wiki

Erweiterung herunterladen

Lizenzhinweis

Die PHP-Skripte können gemäß den Bedingungen der GPL3-Lizenz verwendet werden. Mit dem Download der Dateien akzeptieren Sie die Lizenzbedingungen.

Download

XML-Datei

Die folgende XML-Datei kann in CMS made simple als Erweiterung installiert werden.

• Aktuelle Version herunterladen
• Versionshistorie öffnen

ZIP-Archiv

Die folgende ZIP-Datei beinhaltet alle Skripte des Moduls. Mit dieser Datei kann das Modul 'von Hand' im CMS installiert werden.

• Aktuelle Version herunterladen
• Versionshistorie öffnen

Download via CMSmadesimple.org

Alternativ kann die Erweiterung aus dem Plugin-Verzeichnis von cmsmadesimple.org heruntergeladen werden.

Erweiterung installieren

Installation via XML-Datei

Die einfachste Form der Installation erfolgt über die XML-Datei. Sie benötigen lediglich einen Administratorzugang zur CMSms-Installation.

• Laden Sie die XML-Datei des Moduls herunter.
• Melden Sie sich im Administrationsbereich von CMSms an und klicken Sie auf Erweiterungen » Module.
• Unterhalb der Modultabelle finden Sie ein Formular, um die XML-Datei des Moduls zu installieren. Wählen Sie die heruntergeladene XML-Datei aus und klicken Sie auf Absenden.
• Nach erfolgreicher Installation erscheint das Wrapper-Modul in der obigen Modul-Tabelle. Klicken Sie in der Tabelle abschließend auf Installieren um das Modul zur Verwendung im CMS zu aktivieren.

Screenshots

Modulverwaltung öffnen	Modul via XML-Datei übertragen
Modul installieren

Installation via ZIP-Archiv

Abhängig von den Schreibrechten auf dem Webspace funktioniert die Installation via XML-Datei nicht auf jeder CMS-Installation.

• Laden Sie sich alternativ die ZIP-Datei herunter und entpacken Sie das Archiv auf Ihrem Rechner.
• Kopieren Sie den kompletten Ordner OpenEstatePhpWrapper via FTP auf Ihre Webseite. Das Modul muss in das Verzeichnis modules der CMSms-Installation kopiert werden.
• Melden Sie sich im Administrationsbereich von CMSms an und klicken Sie auf Erweiterungen » Module.
• Das kopierte Modul sollte in der Modulübersicht dargestellt werden. Klicken Sie in der Tabelle abschließend auf Installieren um das Modul zur Verwendung im CMS zu aktivieren.

Screenshots

Modulverwaltung öffnen

Modul installieren

Konfiguration

Bevor das Modul verwendet werden kann, muss mitgeteilt werden, wo auf dem Server der ImmoTool-PHP-Export abgelegt wurde.

• Melden Sie sich im Administrationsbereich von CMSms an und klicken Sie auf Erweiterungen » OpenEstate PHP-Wrapper und öffnen Sie den Reiter Modul Einstellungen.
• Tragen Sie im folgenden Formular den Pfad und die URL auf Ihrem Server ein, wo die aus dem ImmoTool exportierten PHP-Skripte abgelegt wurden.
• Nach einem Klick auf Absenden wird die Anbindung getestet. Im Reiter Integration wird das Ergebnis des Tests dargestellt.

Screenshots

Administration des Moduls	Anbindung der exportierten Skripte
Test der Anbindung fehlgeschlagen	Test der Anbindung erfolgreich

Verwendung

Nach erfolgreicher Installation und Konfiguration kann das Modul in jeder beliebigen Seite (oder jedem beliebigen Template) mit dem Platzhalter {OpenEstatePhpWrapper} eingebunden werden.

• Erzeugen Sie eine neue Seite im CMS und öffnen Sie diese zur Bearbeitung.
• Im Textfeld der Seite kann der Platzhalter {OpenEstatePhpWrapper} eingefügt werden. An dieser Stelle wird der Inhalt der exportierten PHP-Skripte eingebunden, wenn ein Besucher die Webseite besucht.

Die Darstellung des Platzhalters kann über Parameter gesteuert werden. Das Modul stellt Ihnen ein Hilfsformular zur Verfügung, um die gewünschten Einstellungen vorzunehmen.

• Klicken Sie auf Erweiterungen » OpenEstate PHP-Wrapper und öffnen Sie den Reiter Integration.
• Dieses Formular stellt Eingabefelder für alle möglichen Parameter dar. Wenn Sie eine Einstellung ändern, aktualisiert sich der grau hinterlegte Platzhalter-Code entsprechend.
• Der erzeugte Platzhalter-Code kann in jeder beliebigen Seite eingefügt werden.

Screenshots

Hilfsformular zur individiduellen Darstellung

Platzhalter beim Bearbeiten einer Seite einfügen

Besonderheiten

Allgemeine Stylesheets deaktivieren

Um Darstellungsprobleme bei der Einbindung mit den bereits existierenden CSS-Stylesheets zu vermeiden, sollte die Konfigurationsvariable $ShowGeneralStyles deaktiviert werden. Bearbeiten Sie dafür die Datei myconfig.php und ergänzen Sie folgenden Eintrag.

  /**
   * Konfiguration des Stylesheets überschreiben.
   * @param object $config Konfigurations-Objekt
   */
  function load_config_style( &$config )
  {
    // allgemeine Konfiguration (siehe oben)
    immotool_myconfig::load_config_default( $config );
 
    // ggf. individuelle Konfigurationswerte einfügen
    $config->ShowGeneralStyles = false;  }

CSS-Anpassungen

Die Standard-Templates von CMSms registrieren verschiedene Stylesheets, die mit dem PHP-Export 'kollidieren', sodass Fehldarstellungen auftreten. Wenn Sie eines der Standard-Templates (oder eine davon abgewandelte Form) auf Ihrer Webseite verwenden, sind einige CSS-Korrekturen nötig.

(a) Zusätzlichen Stylesheet registrieren

Bearbeiten Sie die Datei myconfig.php und nehmen Sie folgende Ergänzung vor.

  /**
   * allgemeine Konfiguration überschreiben
   */
  function load_config_default( &$config )
  {
    $config->AdditionalStylesheet = 'http://www.meinewebseite.de/immotool_export/mystyle.css';  }

(b) Stylesheet-Datei hinterlegen

Unter der in (a) konfigurierten Adresse muss eine CSS-Datei auf dem Webspace mit folgendem Inhalt hinterlegt werden.

div#main div#page_index,
div#main div#page_expose {
  float:right;
  width: 100%;
}
 
div#main div#openestate_header {
  margin: 1em;
}
 
div#main div.openestate_listing_entry h2 a {
  text-decoration: none;
}
 
div#main div.openestate_listing_entry h2 a:hover {
  text-decoration: underline;
}
 
div#main div#openestate_languages ul li, 
div#main div#openestate_listing_pagination_top ul li, 
div#main div#openestate_listing_pagination_bottom ul li, 
div#main div.openestate_listing_entry div.options ul li,
div#main div#openestate_expose_menu_top ul li,
div#main div#openestate_expose_menu_bottom ul li,
div#main div#openestate_expose_view_menu ul li {
  margin: 0;
}
 
div#main div.openestate_listing_entry div.options {
  padding: 0;
  margin: 0;
  line-height: 1em;
}
 
div#main div.openestate_listing_entry div.options ul {
  display: inline;
}
 
div#main div#openestate_expose_view_menu ul {
  margin: 0;
  padding: 0;
}
 
div#main div#openestate_expose_view_content h2 {
  margin-top: 1em;
}
 
div#main div#openestate_expose_view_content div#openestate_contact_result {
  padding: 1em;
}
 
div#main div#openestate_footer {
  margin-top: 2em;
  margin-bottom: 2em;
  line-height: 1.3em;
}

Mailversand via CMS

Das CMS liefert bereits die nötigen Funktionen zum Mailversand mit. Um bei Kontaktanfragen auf die Mail-Einstellungen von CMSms zurückgreifen zu können, sind folgende Anpassungen an der Datei myconfig.php nötig.

Mailversand via CMS made simple

  /**
   * Mailversand durchführen.
   */
  function send_mail( &$setup, $subject, $body, $mailToAdress, $replyToAdress, $replyToName )
  {
    // Versand via CMS made simple
    if (!is_callable(array('CmsModule', 'GetModuleInstance'))) return null;
    $mailer = CmsModule::GetModuleInstance('CMSMailer');
    if (!is_object($mailer)) return null;
    $mailer->IsHTML( false );
    $mailer->SetBody( $body );
    $mailer->SetSubject( $subject );
    $mailer->SetCharSet( 'UTF-8' );
    $mailer->SetFrom( immotool_functions::encode_mail( $setup->MailFrom ) );
    $mailer->SetFromName( $setup->MailFromName );
    $mailer->AddAddress( immotool_functions::encode_mail( $mailToAdress ) );
    $mailer->AddReplyTo( immotool_functions::encode_mail( $replyToAdress ), $replyToName );
    if (is_string($setup->MailToCC) && strlen(trim($setup->MailToCC))>0)
      $mailer->AddCC( immotool_functions::encode_mail( $setup->MailToCC ) );
    if (is_string($setup->MailToBCC) && strlen(trim($setup->MailToBCC))>0)
      $mailer->AddBCC( immotool_functions::encode_mail( $setup->MailToBCC ) );
    if ($mailer->Send()) return true;
    return $mailer->GetErrorInfo();
  }

Letze Änderungen

Version 0.4.2

• Beim Wechsel zwischen mehreren Immobilienseiten sollen die vom Besucher gewählten Filter-Einstellungen zurückgesetzt werden. (siehe Forum)

Version 0.4

• Überprüfung und Fehlermeldung auf der Webseite, wenn zeitgleich ein PHP-Export via ImmoTool durchgeführt wird. (siehe Bug-Tracker #594)
• Verbesserter Umgang mit suchmaschinenfreundlichen URL's. (siehe CMSms-Wiki)
  • Konfiguration $config['url_rewriting'] wird explizit berücksichtigt.
  • Konfiguration $config['query_var'] wird explizit berücksichtigt.

Version 0.3

• Kleinere Korrekturen im Detail

Version 0.2

• Erste Veröffentlichung des Moduls.

Geplante Verbesserungen

• Übersetzung in weitere Sprachen.