Здравствуйте, сегодня я хочу рассказать Вам о написании помощников вида. Мне нужно было реализовать один очень важный элемент навигации – т.н. "Хлебные крошки" вертикального типа (самый простой вариант). Для написания подобного функционала, я решил воспользоваться помощниками вида, чтобы не морочится с выводом и интеграцией в мою CMS-систему. Заодно я подумал, что было бы неплохо рассказать об этом читателям…

Проблема

Как предоставить пользователю удобный элемент навигации "Breadcrumbs" не нарушая целостность уже готовой системы? Как добавить подобный функционал, с минимальными изменениями в текущем проекте? Как писать помощники вида?

Решение

Решение подобного вопроса довольно тривиальное. Самым лучшим способом, на моё мнение, является написание соответствующего помощника вида, потому, что это самый грамотный вариант (ИМХО). Итак, приступим!

В первую очередь, выясним, что же такое помощник вида в Zend Framework, как их использовать и как дописывать свои помощники.
Помощник вида – это «плагин» Zend_View, который доступен прямо из скриптов вида, реализующий конкретный функционал.

Наиболее полезными помощниками вида я считаю помощников headTitle, headLink, headScript, headMeta. Я их использую наиболее часто. Обо всех этих помощниках можно прочитать в мануале, а у нас же своя задача…

По умолчанию, Zend_View ищет помощники в папке Zend/View/Helper/, а также в папке views/helpers/. А что делать, если нам нужно хранить наши помощники не в этих папках и чтобы они были доступны из любого скрипта вида? Правильно! Нужно показать нашу папку Zend_View. Делается это так:

<?php /** * "Показываем" папку виду и указываем префикс */ $view->addHelperPath('../path/to/ads/Fooup/View/Helper/','Fooup_View_Helper'); /** * Задаем префикс, постфикс и сепаратор */ $view->breadCrumbs()->setPrefix('<div class="breadcrumbs">'); $view->breadCrumbs()->setPostfix('</div>'); $view->breadCrumbs()->setSeparator(' > '); ?>

Вот сам класс плагина, реализующий "Хлебные крошки":

<?php /** Zend_View_Helper_Placeholder_Container_Standalone */ require_once 'Zend/View/Helper/Placeholder/Container/Standalone.php'; /** * Helper Fooup_View_Helper_BreadCrumbs allow you to create an breadcrumbs navigation bar. * Class works with Zend_View_Helper_Placeholder_Container_Standalone. * * @name Fooup_View_Helper_BreadCrumbs * @package Fooup_View * @subpackage Helper * @copyright Copyright (c) 2008-2009 Andrew Vasiliev (http://www.web-blog.org.ua) * @version 0.0.0.1 * */ class Fooup_View_Helper_BreadCrumbs extends Zend_View_Helper_Placeholder_Container_Standalone { /** * @var string registry key */ protected $_regKey = 'Fooup_View_Helper_BreadCrumbs'; /** * Retrieve placeholder for breadcrumbs elements and optionally set state * * @param array $item * @param string $placement * @return Zend_View_Helper_Placeholder_Container_Standalone */ public function breadCrumbs(array $item = array(),$placement = Zend_View_Helper_Placeholder_Container_Abstract::APPEND) { if ($item) { if ($placement == Zend_View_Helper_Placeholder_Container_Abstract::SET) { $this->set($item); } elseif ($placement == Zend_View_Helper_Placeholder_Container_Abstract::PREPEND) { $this->prepend($item); } else { $this->append($item); } } return $this; } /** * Retrieve a rendered string * * @return string */ public function toString() { $output = ''; $items = array(); foreach ($this as $item) { $items[] = '<a href="'.$item['url'].'" mce_href="/admin/articles/article/content/'.$item['url'].'">'.$item['title'].'</a>'; } if (($prefix = $this->getPrefix())) { $output .= $prefix; } $separator = $this->getSeparator(); $output .= implode($separator, $items); if(($postfix = $this->getPostfix())) { $output .= $postfix; } return $output; } } ?>

Итак, разберем пошагово, написанное.

1. В первых строчках мы объявили класс Fooup_View_Helper_BreadCrumbs, унаследовав класс Zend_View_Helper_Placeholder_Container_Standalone (этот класс наследует интерфейс Zend_View_Helper_Interface и имеет базовый функционал необходимый нам);
2. Далее мы объявляем защищенную переменную $_regKey, которая указывает Placeholder'у название отдельного пространства имен для нашего плагина;
3. Объявляем функцию breadCrumbs, которая будет основной в нашем помощнике;
4. И наконец, объявляем функцию toString, которая должна возвращать уже готовую строку для вывода.

Функция breadCrumbs принимает два параметра: первый это элемент (массив с ключами «title» и «url»), а второй, означает тип записи в контейнер (заменить, добавить в конец, добавить в начало). Эта функция выполняется благодаря базовому функционалу помощника под названием "Placeholder". Заметьте, что функция имеет такое же название как и помощник вида. Это и является ключевым моментом - это обязательно!

Функция toString, формирует наш вывод, собирая строку с массива элементов, вставляя разделители, префиксы и постфиксы. В итоге функция возвращает строку, которая уже готова для вывода.

Наведу Вам небольшой пример использования данного помощника:

<?php /** * Создаём один элемент */ $view->breadCrumbs(array('title'=>'Заголовок','url'=>'/url')); /** * Выводим наши "крошки" */ echo $view->breadCrumbs(); ?>

Обратите внимание на название помощника. Оно формируется на основе части имени класса, но без префикса, который мы указали виду.

Как видите, все довольно просто и эффективно. Такой подход очень удобен и грамотен, ведь если бы мы выдумывали какие-то другие системы и решения, то на это ушло бы намного больше времени, да и Zend_View рассчитан на удобное наращивание функционала. А вот результат выполнения подобного кода:

в хэлпере ошибка: метод должен называться "__toString" вместо "toString", т.к. в дальнейшем вы используете его именно как магический метод, не вызывая его явно.

Я как раз тоже сегодня свой Truncate хелпер написал

@LighteR

Обратите, пожалуйста, внимание на унаследованный класс... А потом, пересмотрите свой комментарий 

Спасибо, давно хотел разобраться, как в Zend работают helpers.

Рад, что Вам помогло разобраться 

Подскажите, как в скрипте макета указать ссылку на страницу. У меня к примеру есть макет

<!--begin menu --> <div class="content"> <div class="menu"> <ul> <li><a href="&"quot;about/us" mce_href="&"quot;/articles/about/us">О НАС</a></li> <li><a href="&"quot;#" mce_href="&"quot;#">КОНТАКТЫ</a></li> </ul> </div> <!--begin content --> <div class="main-content"> <div id="content"><?php echo $this->layout()->content ?></div> </div> </div>

Ссылка  в макете <li><a href="&"quot;about/us">О НАС</a></li> по идее должна вызывать контролер about и действие us. Но когда я нажимаю на эту ссылку страница показывается (стили загружаются), но браузер у меня виснит, не отображаються рисунки... В чем может быть проблема и как правильно нужно писать ссылки в макетах скрипта. Я знаю нужно, наверное использовать помощник вида Url-helper, но как его применить не знаю. Может покажите на примере... Спасибо

Все ссылки должны быть абсолютными, т.е.

/styles/styles.css

Это путь от папки public_html, если сказать по простому.

Ссылки на конкретные страници желательно выводить с помощью помошника вида url, например,

<a href="&"quot;<?php echo $this->url(array(),'route_name')?>">Link</a>

Подскажите, пожалуйста. Написал в хелпере следущее:


<a href="&"quot;<?php echo $this->url(array('controller'=>'about', 'action'=>'us', 'username' => 'martel'), 'about'); ?>">О НАС</a>

в роутере:

$router->addRoute('about', new Zend_Controller_Router_Route('about/:username', array('controller' => 'about', 'action' => 'us')));

при этом ссылка сгенерировалась вот так:

<a href="&"quot;/about/martel" mce_href="&"quot;/about/martel">О НАС</a>

страница отобразилась но ни рисунки ни другие элементы страницы не загрузились!!! Оно ищщет вроде бы действие martel которое было указано в массиве, хотя это есть значение переменной username.
Почему рисунки не отображаются? Может нужно где-то указать в настройках или в чем проблема? Спасибо за помощь!!! 

Во первых, контроллер и действие передавать в первый параметр помощника, в вашем случае не обязательно.

Во вторых, если нет картинок и стилей, то первым делом посмотрите на пути к ним в исходном коде страници. Убедитесь, что используете абсолютные пути к файлам, а не относительные...

к стати, когда на ссылку в просмотре кода странице нажимаю выдает вот такое сообщение:

Проверил пути к рисункам, и когда на ссылку рисунка (к примеру

<img src="img/main-1.gif" mce_src="/articles/img/main-1.gif" width="172" height="130" alt="img" />)  

в просмотре кода странице нажимаю выдает вот такое сообщение:

<!--error--><br /> <b>Fatal error</b>: Uncaught exception 'Zend_Controller_Action_Exception' with message 'Action "img" does not exist and was not trapped in __call()' in Z:homeualicarlibsZendControllerAction.php:485 Stack trace: #0 Z:\home\ualicar\libs\Zend\Controller\Action.php(515): Zend_Controller_Action->__call('imgAction', Array) #1 Z:\home\ualicar\libs\Zend\Controller\Dispatcher\Standard.php(289): Zend_Controller_Action->dispatch('imgAction') #2 Z:\home\ualicar\libs\Zend\Controller\Front.php(946): Zend_Controller_Dispatcher_Standard->dispatch(Object(Zend_Controller_Request_Http), Object(Zend_Controller_Response_Http)) #3 Z:\home\ualicar\applications\system\Bootstrap.php(42): Zend_Controller_Front->dispatch() #4 Z:\home\ualicar\www\index.php(22): Bootstrap->run(Array) #5 {main} thrown in <b>Z:homeualicarlibsZendControllerAction.php</b> on line <b>485</b><br /> <mce:script language=JavaScript src="/denwer/errors/phperror_js.php" mce_src="/denwer/errors/phperror_js.php"></mce:script>

что интиресно если пишу вот так:

<li><a href="&"quot;<?php echo $this->url(array('controller'=>'about', 'action'=>'us'), 'about'); ?>">О НАС</a></li>

и в роутере:

$router->addRoute('about', new Zend_Controller_Router_Route('about/', array('controller' => 'about', 'action' => 'us')));

формируется вот такая ссылка которая работает и рисунки загружаются:

<li><a href="&"quot;/about" mce_href="&"quot;/about">О НАС</a></li>

а когда напишу в хелпере:

<li><a href="&"quot;<?php echo $this->url(array('controller'=>'about', 'action'=>'us', 'username'=>'matrial'), 'about'); ?>">О НАС</a></li>

и в роутере

$router->addRoute('about', new Zend_Controller_Router_Route('about/:username', array('controller' => 'about', 'action' => 'us')));

страница открывается а рисунки не грузятся, и пиуть к рисункам остается тот же что и был при нормальной загрузке странице, когда я в хелпер и роутер не добавил username->material. Оно как бы ищет действие material которого нет... Парадокс какой то....

Спасибо за подсказку, заработал демон.... абсолютные пути нужно указывать....

Здравствуйте!

Подскажите, я не могу разобраться с помощником вида. Создал помощник вида с именем

FooBar.php и разместил его по такому пути: applications/views/My/Helper/FooBar.php

<?php class My_Helper_FooBar { public $view; public function fooBar() { return 'fooBar'; } }

Затем в контролере зарегестрировал этот помощник вида, написав:

$view->addHelperPath('My/Helper/', 'My_Helper');

Но при этом мневыдает ошибку:

Fatal error: Call to a member function addHelperPath() on a non-object in Z:\home\aqua\www\applications\controllers\ErrorController.php on line 12

Где сдесь проблема? Где нужно размещать помощники вида??? Спасибо!!!

Когда я размещаю файл в папке Zend/View/Helper/FooBar.php где находяться все помощники без указания метода addHelperPath() все работает, а когда мне надо скажем поместить помощник вида в папку applications/views/My/Helper/FooBar.php я использую этот метод

$view = new Zend_View;

$view->addHelperPath('My/Helper/', 'My_Helper');

и мне выдает ошибку:

Fatal error: Uncaught exception 'Zend_Loader_PluginLoader_Exception' with message 'Plugin by name 'FooBar' was not found in the registry; used paths: My_Helper_: My/Helper/ Zend_View_Helper_: Zend/View/Helper/' in

Наверное где-то не првильно путь указал!!!

Как првильно нужно указать путь??? Спасибо!!!

Чуть не в тему о "крошках", но о навигации.
Автор (или кто-нить) ткните носом в такую вещь.

Надо реализовать выделение активной страницы в горизонтальном верхнем меню (например, другим стилем). Для этого есть специальный инструмент, или надо писать что-то свое? Если свое, то интересует алгоритм. Можно и реализацию.

Набор пунктов меню  - статический (например, Главная, Личный кабинет, О нас). Классы стилей описаны.
В блоге ничего похожего не нашел.

Спасибо.