custom view helpers

freenity · #1 (**permalink**) 04-29-2008, 05:43 PM

Hi
I made my custom view helper andto use them I have to add my path to the view object:

PHP Code:


			
$view->addHelperPath("../application/default/views/helpers");

But, the problem is that I have to do this in every action where I want to use my helper, and I can't find a way to set this path once, say in a bootstrap....

Is there any easy and fun ways of doing this?

and not having to add the path in every action..

Thanks.

Davidoff · #2 (**permalink**) 04-29-2008, 10:10 PM

If you're using the ViewRenderer it couldn't be simpler:

PHP Code:


			
$viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');

$viewRenderer->initView();



//your line

$viewRenderer->view->addHelperPath("../application/default/views/helpers");

Elemental · #3 (**permalink**) 04-30-2008, 01:59 PM

Davidoff's solution is indeed simple, however it appears as though you're using a conventional modular file structure. If so, then once you have helpers in modules other than default Davidoff's solution will stop working for you.

You could set the helper path per request via an Action Helper and set it based on the requested module as so:

PHP Code:


			
<?php

require_once('Zend/Controller/Plugin/Abstract.php');

class MyApp_Controller_Plugin_ModularHelperPath extends Zend_Controller_Plugin_Abstract
{
    public function preDispatch(Zend_Controller_Request_Abstract $request)
    {
        $moduleName = $request->getModuleName();
        $rootDir = Zend_Registry::get('rootDir');
        set_include_path(get_include_path() .
                         PATH_SEPARATOR . $rootDir . '/application/' . $moduleName . '/views/helpers/');
    }
}

$rootDir = Zend_Registry::get('rootDir') assumes you have set the rootDir in your bootstrap, otherwise you will need to adjust the script to set the paths appropriately.

freenity · #4 (**permalink**) 04-30-2008, 08:02 PM

Quote:

Originally Posted by Elemental

Davidoff's solution is indeed simple, however it appears as though you're using a conventional modular file structure. If so, then once you have helpers in modules other than default Davidoff's solution will stop working for you.

You could set the helper path per request via an Action Helper and set it based on the requested module as so:

PHP Code:


			
<?php



require_once('Zend/Controller/Plugin/Abstract.php');



class MyApp_Controller_Plugin_ModularHelperPath extends Zend_Controller_Plugin_Abstract

{

    public function preDispatch(Zend_Controller_Request_Abstract $request)

    {

        $moduleName = $request->getModuleName();

        $rootDir = Zend_Registry::get('rootDir');

        set_include_path(get_include_path() .

                         PATH_SEPARATOR . $rootDir . '/application/' . $moduleName . '/views/helpers/');

    }

}

$rootDir = Zend_Registry::get('rootDir') assumes you have set the rootDir in your bootstrap, otherwise you will need to adjust the script to set the paths appropriately.

Thanks for the reply guys.
I will try the Davidoffs solution, I was hoping was something that would work by putting it in the bootstrap file once, seems like this should work.

Davidoff · #5 (**permalink**) 05-01-2008, 08:21 AM

Yep - I haven't worked with modules but I think Elemental has it bang on.

I guess you could access the request in the bootstrap and make a decision there, but you might as well use a Controller Plugin.

freenity · #6 (**permalink**) 05-01-2008, 12:21 PM

Hi
Davidoff's solution didn't work,
and for the plugin I have a question: why do you include the path instead of using addHelperPath() ?
I tried including the path in the bootstrap file, but it didn't work.
Also the path is: ../application/default/views/helpers
And default it's just a folder that Zend Studio creates (don't know why). But this never changes.
I don't know if you understood me well, I'm new to ZF so maybe some things I don't quite understood.
Thanks for the help.

Davidoff · #7 (**permalink**) 05-01-2008, 01:17 PM

I took the line from your example.

But you probably need to pass the second parameter with the class name prefix.

Sample code from my live, working app:

PHP Code:


			
$viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');



$viewRenderer->initView();



$viewRenderer->view->addHelperPath(APPLICATION_DIRECTORY . '/views/helpers', 'My_View_Helper');

Example helper class name is class My_View_Helper_ContactSelect for the helper 'contactSelect'

According to the API Docs, Docs For Class Zend_View_Abstract, the second argument defaults to Zend_View_Helper

freenity · #8 (**permalink**) 05-01-2008, 01:39 PM

Thanks a lot

It worked.
I forgot about the prefix, lol

Many thanks again Davidoff

Thread Tools
Show Printable Version Email this Page
Display Modes
Linear Mode Switch to Hybrid Mode Switch to Threaded Mode