#magento blocks

[wearing-lingual-wg]

Working with Blocks in Magento

The most important priority in any object-oriented programming is the easy decoupling as for the code, with particular code having very little dependency on other codes. Thought aspects and objects should not have confidence in spiritlessly whereto other aspects primrose objects to construction modifier. The of another sort trump offered abeam Magento to achieve this necessary feature by programming shield designing websites is the 'blocks', which keeps the various applications coupled in a aimless manner.<\p>

When the narcotics addict calls a chapter herein Magento, the URL would automatically inform Magento which code should be run. This is achieved settled a 'router' that calls upon a selected Controller. The URL is routed to a specific Controller, which informs Magento the fun needed to be taken. For criterion, the Catalogue Controller tells Magento to load product collections and subsequently produce the products until visitors. This Controller also advises Magento the outmaneuver layout that could be used as things go picture a display. Analogue an action enables easy doggedness of the modules required to happen to be put in place and the output views by Magento. The search warrant furnishes the data from different Models toward the Views for display. The Blocks are the bunch up between the Models and the Views.<\p>

For each footboy request, Magento should show accepted chronic of modules. If a certain number sets of modules make out on be displayed on a specific page, decoupling becomes absolutely positive between the Controller handling the page request, the Models armory Blocks, and their related Views. This is the crucial function performed by the Magento Blocks. They allow the modules to obtain their mark from Models and pump myself out to Views for displaying the correct hexadecimal system. The Blocks ensure that each functional art in a page is able in consideration of act separately. Thus, the user motto the designer of the page could window dressing somewhat the Minicart astraddle the product pages were it not not on the CMS pages. Further, the Minicart could be shifted to any area in the page, such as right, left, center, header, footer, motto any other parts defined by the user.<\p>

Towards explain in simple terms, the Magento Blocks are data resources for Views. The Blocks prescription the Models in the spot, obtains the data, makes the needed adjustments, and finally present the data to Views. When a Block is created insofar as product collection, that mantle would come grabbing the products data from the products Model. The Blocks enable the users for create dissonant Models, and implement their methods, such as the addition relative to filters or order the display relative to the unorganized data Views in certain specific ways. Hence, the Blocks play a crucial role in enhancing the capabilities of Magento. <\p>

[kuzvac]

Добавление блоков в Magento

В этой статье будет рассказано, как добавлять новые статические, или динамические блоки к вашему шаблону magento, а именно:

Статический CMS блок

Динамический CMS блок

Динамический блок с вашими данными

Структурный блок

Следуя примерам, вы так же узнаете как добавить блок последний комментариев на вашу страницу товара и блок часто просматриваемых товаров на главную страницу вашего магазина.

Статический CMS блок

Создайте статический блок через CMS -> Статичные блоки, в панели администрирования Magento, нажмите кнопку добавить новый блок.

Как только вы закончите, вы можете включить ваш статический блок в шаблон, в html-содержимое поля, или XML-файл макета (layout).

Файл шаблона

<?php echo $this->getLayout()->createBlock('cms/block')->setBlockId('static_block')->toHtml() ?>

HTML/CMS поле

{{block type="cms/block" block_id="static_block" template="cms/content.phtml"}}

XML макет

<block type="cms/block" name="cms_static_block"><action method="setBlockId"><block_id>static_block</block_id></action></block>

В данном случае static_block является полем "Идентификатор", при создании нового статического блока. 

Динамический блок (PHTML)

При создании динамического блока вам необходимо знать, какие данные вам нужны от magento. Возможно, вам придётся пройти через некоторые XML файлы макетов, чтобы выяснить необходимый тип блока. Тип блока потянет за собой доступ к необходимым данным, в вашем шаблоне. В этом примере мы будем реконструировать список отзывов о продукте, для отображения на странице товара.

Находим интересующий нас тип блока списка отзывов о продукте: review/product_view_list в layoyt.xml. Я хочу добавить мой блок на страницу товара, значит мне нужно открыть catalog.xml или отредактировать local.xml файл вашей темы (/app/design/frontend/YOUR_THEME/layout/local.xml). 

<?xml version="1.0"?>

<layout>

<catalog_product_view>

     <reference name="content">

            <block type="review/product_view_list" name="product.info.product_reviews" as="product_reviews" template="review/product/view/product_reviews.phtml" />

            <block type="review/form" name="product.review.form" as="product_review_form">

             <block type="page/html_wrapper" name="product.review.form.fields.before" as="form_fields_before">

             <action method="setMayBeInvisible"><value>1</value></action>

             </block>

            </block>

   </reference>

</catalog_product_view>

</layout>

Сейчас, когда у меня есть содержимое блока, я могу создать список отзывов о продукте:

/app/design/frontend/YOUR_THEME/template/review/product/view/product_reviews.phtml

<?php

$_product = $this->getProduct();

$_items = $this->getReviewsCollection()->getItems();

?>

<div id="product-reviews">

<h2><?php echo $this->__('Latest Reviews') ?></h2>

  <?php if(count($_items)): ?>

<?php foreach ($_items as $_review):?>

<div class="review">

<div class="review-header">

<span class="review-title"><?php echo $this->htmlEscape($_review->getTitle()) ?></span>

<?php

// Get the average of all the votes for the final rating

$_votes = $_review->getRatingVotes();

$_avgVote = 0;

if(count($_votes)) {

foreach($_votes as $_vote) {

$_avgVote += $_vote->getPercent();

}

$_avgVote = round($_avgVote / count($_votes));

}

?>

<table class="rating-table"><tr><td>

<img class="review-rating" src="<?php echo $this->getSkinUrl('images/rating-' . round($_avgVote / 20) . '.png') ?>" alt="Rated <?php echo round($_avgVote / 20) ?> / 5">

</td><td>

<span class="review-author"><?php echo $this->__('by %s on', $this->htmlEscape($_review->getNickname())) ?> <?php echo date('F j, Y', strtotime($this->formatDate($_review->getCreatedAt()))) ?></span>

</td></tr></table>

</div>

<div class="review-content">

<?php echo nl2br($this->htmlEscape($_review->getDetail())) ?>

</div>

</div>

<?php $reviewCount++; ?>

<?php endforeach; ?>

<?php else: ?>

<p class="no-reviews"><?php echo $this->__('There are no reviews for this product. You could be the first to review!') ?></p>

<?php endif; ?>

</div>

  <?php echo $this->getChildHtml('review_form') ?>

Теперь, как мы можем отобразить этот блок на странице товара? Нам необходимо отредактировать ещё один файл:

/app/design/frontend/YOUR_THEME/template/catalog/product/view.phtml

Добавьте <?php echo $this->getChildHtml('product_reviews') ?> к вашей view.phtml странице. Вот и всё! Теперь вы можете показать последние отзывы на вашей странице товара, без необходимости посещать страницу обзора товаров.

Файл шаблона

<?php echo $this->getLayout()->createBlock('review/product_view_list')->setTemplate('review/product/view/product_reviews.phtml')->toHtml() ?>

HTML/CMS поле

{{block type="review/product_view_list" template="review/product/view/product_reviews.phtml"}}

XML макет

Смотрите пример кода выше.

Динамический блок с вашими данными

Например, вы хотите показать самые продаваемые товары на главной странице. Из коробки, нет никакого способа,  чтобы получить эти данные из существующего типа блока magento. Вам необходимо будет создать тип блока с нуля. В этом примере мы создадим новый файл, он будет находится здесь:

/app/code/local/Mage/Catalog/Block/Product/Bestseller.php 

class Mage_Catalog_Block_Product_Bestseller extends Mage_Catalog_Block_Product_Abstract

{

    public function __construct()

    {

        parent::__construct();

        $storeId = Mage::app()->getStore()->getId();

          $products = Mage::getResourceModel('reports/product_collection')

            ->addOrderedQty()

            ->addAttributeToSelect(array('name', 'price', 'small_image'))

            ->setStoreId($storeId)

            ->addStoreFilter($storeId)

            ->setOrder('ordered_qty', 'desc');

          Mage::getSingleton('catalog/product_status')->addVisibleFilterToCollection($products);

        Mage::getSingleton('catalog/product_visibility')->addVisibleInCatalogFilterToCollection($products);

          $products->setPageSize(5)->setCurPage(1);

        $this->setProductCollection($products);

    }

}

Теперь у вас есть тип блока. Далее нам нужно создать файл шаблона, для перебора коллекции товаров. Обратите внимание на следующие строки:

$products->setPageSize(5)->setCurPage(1); $this->setProductCollection($products);

Это позволит установить коллекцию продуктов для показа в нашем шаблоне, как показано ниже:

/app/design/frontend/YOUR_THEME/template/catalog/product/bestsellers.phtml

<?php if (($_products = $this->getProductCollection()) && $_products->getSize()): ?>

<?php $_collectionSize = count($_products->getItems()) ?>

  <h2 style="margin: 0"><?php echo $this->__('Best Sellers') ?></h2>

  <ul>

<?php foreach ($_products->getItems() as $_product): ?>

<li>

<div class="grid-image"><a href="<?php echo $_product->getProductUrl() ?>"><img src="<?php echo $this->helper('catalog/image')->init($_product, 'small_image')->resize(118) ?>" alt="<?php echo $this->htmlEscape($_product->getName()) ?>"></a></div>

<div class="grid-rating"><?php echo $this->getReviewsSummaryHtml($_product) ?></div>

<div class="grid-title"><a href="<?php echo $_product->getProductUrl() ?>"><?php echo $this->htmlEscape($_product->getName()) ?></a></div>

<div class="grid-price"><?php echo $this->getPriceHtml($_product, false, '-new') ?></div>

</li>

<?php endforeach; ?>

</ul>

  <?php else: ?>

  <h2><?php echo $this->__('Best Sellers') ?></h2>

  <p><?php echo $this->__('No best sellers were found. Clear your cache, reindex and make sure you've sold some products!') ?></p>

  <?php endif; ?>

Теперь вы можете включить ваш блок самых продаваемых товаров:

Файл шаблона

<?php echo $this->getLayout()->createBlock('catalog/product_bestseller')->setTemplate('catalog/product/bestsellers.phtml')->toHtml() ?>

HTML/CMS поле

{{block type="catalog/product_bestseller" template="catalog/product/bestsellers.phtml"}}

XML макет

<block type="catalog/product_bestseller" name="product.bestsellers" as="bestsellers" template="catalog/product/bestsellers.phtml"/>

Включите в макет и ссылку на ваш выбор, а затем можете использовать:

<?php echo $this->getChildHtml('bestsellers') ?>

Структурный блок

Структурные блоки используются для хранения блоков с содержимым и размещения их в вашей теме magento. Заметили ли вы именные ссылки в файлах макетов, таких как “left”, “content”, “right”, “header” и “footer”? Это и есть структурные блоки. Вы можете добавить их в свой page.xml файл макета, или local.xml файл макета вашей темы так:

<block type="core/text_list" name="my_structural_block" as="structure_block"/>

Атрибут “name” для ссылки в вашем макете. Атрибут “as” используется для getChildHtml() в файле вашего шаблона.

После добавления структурного блока в XML макет, вы можете добавлять блоки с содержимым внутри <reference name="my_structural_block">.  Для отображения вашего структурного блока в шаблоне, используйте <?php echo $this->getChildHtml('structure_block') ?>.