Schmidt Medienservice

Erstellen einer Magento Erweiterung / Extension (Modul)

Hier zeige ich wie man ein einfaches Modul für Magento erstellt. Das Modul sorgt dafür ein einzelnes Produkt aus einer definierten Kategorie per Zufall darzusstellen. "Sms" ist der Entwickler der Extension und "Angebote" der Name des Moduls. Legen Sie folgende Ordnerstruktur an und achten Sie peinlichst auf die Groß-/Kleinschreibung:

• /app/code/local/Sms
• /app/code/local/Sms/Angebote
• /app/code/local/Sms/Angebote/controllers
• /app/code/local/Sms/Angebote/etc
• /app/code/local/Sms/Angebote/Helper
• /app/design/frontend/default/"Ihr Theme"/template/sms/angebote

Danach legen Sie folgende Dateien an. Auch hier achten Sie bitte wieder auf die Groß-/Kleinschreibung:

• /app/code/local/Sms/Angebote/controllers/IndexController.php
• /app/code/local/Sms/Angebote/etc/config.xml
• /app/code/local/Sms/Angebote/Helper/Data.php
• /app/design/frontend/default/"Ihr Theme"/template/sms/angebote/content.phtml

Im Controller legen Sie fest, wie unser Modul angezeigt werden soll. Zur Prüfung können Sie später das Modul über den Browser direkt aufrufen.

Datei: /app/code/local/Sms/Angebote/controllers/IndexController.php

<?php echo htmlspecialchars('<?php class Sms_Angebote_IndexController extends Mage_Core_Controller_Front_Action { public function indexAction() { $this->loadLayout(); $this->getLayout() ->getBlock(\'root\') ->setTemplate(\'page/2columns-left.phtml\'); $this->renderLayout(); } }'); ?>

Die config.xml

• modules => enthält die Versionsnummer und muss in jeder Extension vorhanden sein
• global => hier werden alle Helper, Models und Installationsscripte Magento bekannt gegeben
• resources => hier definieren wir den Datenbankzugriff für Lese- beziehungsweise Schreibzugriffe
• global => "helpers" – definiert in dieser Extension den Helper
• frontend => definiert alle Frontendeigenschaften wie Templates, Sprachdateien (übersetzungsdateien) und vor allem den Frontendnamen zum späteren Aufruf über den Browser

Datei: /app/code/local/Sms/Angebote/etc/config.xml

<?xml version="1.0" encoding="UTF-8"?> <config> <modules> <Sms_Angebote> <version>0.0.1</version> </Sms_Angebote> </modules> <global> <helpers> <sms_angebote> <class>Sms_Angebote_Helper</class> </sms_angebote> </helpers> </global> <resources> <smsangebote_write> <connection> <use>core_write</use> </connection> </smsangebote_write> <smsangebote_read> <connection> <use>core_read</use> </connection> </smsangebote_read> </resources> <frontend> <layout> <updates> <sms_angebote> <file>angebote.xml</file> </sms_angebote> </updates> </layout> <translate> <modules> <sms_angebote> <files> <default>Sms_Angebote.csv</default> </files> </sms_angebote> </modules> </translate> </frontend> </config>

Die Data.php

Das Herzstück unseres Magento-Moduls. Hier wird die Logik definiert die zur Ausgabe unseres Angebotsartikels führt. Wir übergeben in der Variable $angebotid die Kategorie-Id der Kategorie aus der wir die Produkte laden wollen Auf Basis der Kategorie-Id laden wir uns das die Produktkollektion $angebotproducts per random und begrenzen die Anzahl der Produkte via limit(1). Am Ende übergeben wir das array $angebote_array mit den benötigten Feldern zurück an unsere Abfrage (die .phtml, dazu später mehr).

Datei: /app/code/local/Sms/Angebote/Helper/Data.php

<?php echo htmlspecialchars('<?php class Sms_Angebote_Helper_Data extends Mage_Core_Helper_Abstract { public function angebot($angebotid) { $angebote = new Mage_Catalog_Model_Category(); $angebote->load($angebotid); $angebotproducts = $angebote->getProductCollection(); $angebotproducts->addAttributeToSelect(\'*\'); $angebotproducts->getSelect()->order(\'RAND()\'); $angebotproducts->getSelect()->limit(1); $angebote_array = array(); foreach($angebotproducts as $angebot) { $angebotimg = Mage::helper(\'catalog/image\')->init($angebot, \'small_image\')->resize(50,50); $angebotname = $angebot->getName(); $angebotname = substr($angebotname,0,43); $angebotsku = $angebot->getSku(); $angebotsurl = $angebot->getUrlPath(); $angebotvk = $angebot->getFinalPrice(); $angebotsshortdescription = $angebot->getShortDescription(); $angebotsshortdescription = strip_tags($angebotsshortdescription); $angebotsshortdescription = substr($angebotsshortdescription,0,80); array_push($angebote_array, $angebotimg, $angebotname, $angebotsku, $angebotsshortdescription, $angebotsurl, $angebotvk); } return $angebote_array; } }'); ?>

Als nächstes benötigen wir eine Datei die Magento anweist unser neues Modul im System einzubinden. Bei uns ist es

die Sms_Angebote.xml

Die Sms_Angebote.xml installieren wir in den Ordner /app/etc/modules.

Datei: /app/etc/modules/Sms_Angebote.xml

<?xml version="1.0" encoding="UTF-8"?> <config> <modules> <Sms_Angebote> <active>true</active> <codePool>local</codePool> </Sms_Angebote> </modules> </config>

Die content.phtml

Die content.phtml zeigt unser neues Modul im Frontend an und ruft die im Helper definierte Funktion auf. Der Aufruf findet über die Eingabe des Frontend-Namens im Browser statt. Die Einbindung dieses Moduls nehmen Sie dann an geeigneter Stelle in der local.xml im Ordner "layout" vor.

<?php echo htmlspecialchars('<?php /** Autor: Wolf Schmidt, 11.02.2015 * Schmidt Medienservice */ $angebote_array = Mage::helper(\'sms_angebote\')->angebot(2577); $angebotname = $angebote_array[1]; $angebotsku = $angebote_array[2]; $angebotimg = $angebote_array[0]; $angebotvk = $angebote_array[5] * 1.23; $angebotvk = number_format($angebotvk,2,",","."); $link = "http://" . $_SERVER[\'HTTP_HOST\'] . "/" . $angebote_array[\'4\']; ?> <div class="block block-cart"> <div class="block-inner"> <div class="block-title"> <strong><span><?php echo $this->__(\'SPECIAL OFFERS\') ?></span></strong> </div> <div class="block-content"> <ol id="cart-sidebar" class="mini-products-list"> <li class="item"> <a href="<?php echo $link; ?>"> <img src="<?php echo $angebotimg; ?>" width="50" height="50" title="<?php echo $angebote_array[\'1\']; ?>"> </a> <div class="product-details"><a href="<?php echo $link; ?>"><?php echo $angebote_array[\'3\'] ?></a></div> </li> </ol> <script type="text/javascript">decorateList(\'cart-sidebar\', \'none-recursive\')</script> <div class="summary"> <p class="subtotal"> <span class="label"><?php echo $this->__(\'Offer Price\') ?></span> <span class="price"><?php echo $angebotvk; ?></span> <?php if (Mage::app()->getStore()->getName() == "Polski"): ?> <span class="mwstzeile"><br /><?php echo Mage::getModel(\'core/variable\')->loadByCode(\'PREIS_UNTERZEILE_PL\')->getValue(\'html\'); ?></span> <span class="mwstzeile" data-ot="<?php echo Mage::getModel(\'core/variable\')->loadByCode(\'POP_UP_PL\')->getValue(\'html\'); ?>" data-ot-delay="0" data-ot-style="glass"><a href="<?php echo $this->escapeUrl($this->getBaseUrl())."Versandbedingungen"; ?>"><?php echo $this->__(\'Shipping Cost\'); ?></a>)</span> <?php endif ?> <?php if (Mage::app()->getStore()->getName() == "German"): ?> <span class="mwstzeile"><br /><?php echo Mage::getModel(\'core/variable\')->loadByCode(\'PREIS_UNTERZEILE_DE\')->getValue(\'html\'); ?></span> <span class="mwstzeile" data-ot="<?php echo Mage::getModel(\'core/variable\')->loadByCode(\'POP_UP_DE\')->getValue(\'html\'); ?>" data-ot-delay="0" data-ot-style="glass"><a href="<?php echo $this->escapeUrl($this->getBaseUrl())."Versandbedingungen"; ?>"><?php echo $this->__(\'Shipping Cost\'); ?></a>)</span> <?php endif ?> <?php if (Mage::app()->getStore()->getName() == "English"): ?> <span class="mwstzeile"><br /><?php echo Mage::getModel(\'core/variable\')->loadByCode(\'PREIS_UNTERZEILE_UK\')->getValue(\'html\'); ?></span> <span class="mwstzeile" data-ot="<?php echo Mage::getModel(\'core/variable\')->loadByCode(\'POP_UP_UK\')->getValue(\'html\'); ?>" data-ot-delay="0" data-ot-style="glass"><a href="<?php echo $this->escapeUrl($this->getBaseUrl())."Versandbedingungen"; ?>"><?php echo $this->__(\'Shipping Cost\'); ?></a>)</span> <?php endif ?> </p> </div> <div class="actions"> <?php $category = Mage::getModel(\'catalog/category\')->load(2577); ?> <button type="button" title="<?php echo $this->__(\'All Offers\'); ?>" class="button" onClick="setLocation(\'<?php echo $category->getUrl(); ?>\')"> <span> <span><?php echo $this->__(\'All Offers\') ?></span> </span> </button> </div> </div> </div> </div> <div class="clearfix"></div>');?>