So this is a quick warning to all you Doctrine users. Unless you want to actually override the isValid method for saving, call your check method function something else!

Hopefully it will still be available in the end. Oh well still, Come along to PHPNW10 Conference and see my talk on Zend_Tool

See you all there

The Course will be held on a Sunday and will split over two consecutive weekends.
Day 1: HTML
This will cover HTML, What it is, how it’s used and what you can do with it.
It will also include covering of some of the currently usable HTML5 tags.

Day 2: CSS
This will cover CSS, What it is, how it works and how that applies to HTML.
We shall also cover a smidgeon of CSS3.

Provisionally this course will take place in October.
Please do keep an eye out for more information, I shall be updating with more details as I have them

If you haven’t got your ticket yet, please do. The Conference is not only a great way to learn new things but it’s also a great place to socialise with your fellow developers.

I Hope to see you all there.

So I present to you active Module Config V2

Many thanks to Paul Bouzakis (@paul_eye) for the pointers in ways to make this more readable and concise

<?php
class BinaryKitten_ModuleConfig extends Zend_Controller_Plugin_Abstract
{
    /**@var string The Init Name aka initModule */
    private $_moduleInitName = '';

    public function routeShutdown(Zend_Controller_Request_Abstract $request)
    {
        $activeModuleName = $request->getModuleName();
        $this->_moduleInitName = $activeModuleName."Init";

        $appBootstrap = $this->_getMainBootstrap();
        $activeModuleBootstrap = $this->_getActiveBootstrap($appBootstrap, $activeModuleName);
        $this->_processApplicationBootstrap($appBootstrap);
        if ($activeModuleBootstrap instanceof Zend_Application_Module_Bootstrap) {
            $this->_processActiveModuleBootstrap($activeModuleBootstrap);
        }
    }

    /*****************************************************************
     * Gets the Main Boostrap Object
     *
     * @return Zend_Application_Bootstrap_Bootstrap Main Bootstrap
     *****************************************************************/
    private function _getMainBootstrap()
    {
        $frontController = Zend_Controller_Front::getInstance();
        $bootstrap =  $frontController->getParam('bootstrap');
        return $bootstrap;
    }

    /*******************************************************************************
     * Gets the Current Active Module's Boostrap Object
     *
     * @param Zend_Application_Bootstrap_Bootstap $appBootstrap The Main Bootstrap
     * @param String $activeModuleName The name to find.
     * @return Zend_Application_Module_Bootstrap Active Module Bootstrap
     ******************************************************************************/
    private function _getActiveBootstrap($appBootstrap, $activeModuleName)
    {
        $moduleList = $appBootstrap->modules;
        if (isset($moduleList[$activeModuleName])) {
            $activeModule = $moduleList[$activeModuleName];
        } else {
            $activeModule = $appBootstrap;
        }
        return $activeModule;
    }

     /*********************************************************
     * Process the methods from within the main bootstrap
     * @param Zend_Application_Bootstrap_BootstrapAbstract $appBootstrap The Application Bootstrap;
     **********************************************************/
    private function _processApplicationBootstrap($appBootstrap)
    {
        $moduleInitNameLength = strlen($this->_moduleInitName);
        $bootstrapMethodNames = get_class_methods($appBootstrap);
        foreach ($bootstrapMethodNames as $key=>$method) {
            $runMethod = false;
            $methodNameLength = strlen($method);
            if ($this->_isModuleNameInitMethod($method)) {
                $resource = call_user_func(array($appBootstrap, $method));
                $resourceName = substr($method, $moduleInitNameLength);
                if (!is_null($resource)) {
                    $this->storeResource($resource, $resourceName, $appBootstrap);
                }
            }
        }
    }

    /*********************************************************
     * Process the methods from within the main bootstrap
     * @param Zend_Application_Module_Bootstrap $activeModuleBootstrap The "Active"  Modules's Bootstrap;
     **********************************************************/
    private function _processActiveModuleBootstrap($activeModuleBootstrap)
    {
        $moduleInitNameLength = strlen($this->_moduleInitName);
        $methodNames = get_class_methods($activeModuleBootstrap);
        foreach ($methodNames as $key=>$method) {
            $runMethod = false;
            if ($this->_isActiveInitMethod($method)) {
                $resourceName = substr($method, 10);
                $runMethod = true;
            } elseif ($this->_isModuleNameInitMethod($method)) {
                $resourceName = substr($method, $moduleInitNameLength);
                $runMethod = true;
            }
            if ($runMethod) {
                $resource = call_user_func(array($activeModuleBootstrap, $method));
                if (!is_null($resource)) {
                    $this->storeResource($resource, $resourceName, $activeModuleBootstrap);
                }
            }
        }
    }

    /*******************************************************
     * Check to see if the method is in style of ModulenameInitXXX
     * @param string $method The method name to check
     ********************************************************/
    private function _isModuleNameInitMethod($method)
    {
        $methodNameLength = strlen($method);
        $moduleInitNameLength = strlen($this->_moduleInitName);
        $methodNameLonger = ($moduleInitNameLength < $methodNameLength);
        $methodNameBeginMatch = $this->_moduleInitName == substr($method, 0, $moduleInitNameLength);
        return $methodNameLonger && $methodNameBeginMatch;
    }

    /*******************************************************
     * Check to see if the method is in style of activeInitXXX
     * @param string $method The method name to check
     ********************************************************/
    private function _isActiveInitMethod($method)
    {
        $methodNameLength = strlen($method);
        $methodNameLonger = ($methodNameLength > 10);
        $methodNameBeginMatch = 'activeInit' === substr($method, 0, 10);
        return $methodNameLonger && $methodNameBeginMatch;
    }

    /***********************************
     * Store the resource returned by the function so that it can be "bootstrapped"
     * @param misc $resource The Resource to be stored
     * @param string $name the name of the resource
     * @param Zend_Application_Bootstrap_BootstrapAbstract $bootstrap The Bootstrap against which to store the resource
     ********************/
    private function storeResource($resource, $name, $bootstrap)
    {
        // Store the resource.. not sure how to do this yet.. if you do let me know! 
    }
}

Anyway, I really wanted to make use of them in an application I’ve been using and after reading John Resig’s (@jresig) post on the subject (http://ejohn.org/blog/html-5-data-attributes/) I set about adding a little snippet to extend jQuery’s .data so that it would support these parameters. So here is the small plugin that will extend the data function in jQuery to enable access to this functionality.

Enjoy

(function($){
    $.fn.extend({
        '_data': $.fn.data,
        'data' : function( key, value ) {
            if ( typeof key === "undefined" && this.length ) {
                return jQuery.data( this[0] );
            } else if ( typeof key === "object" ) {
                return this.each(function() {
                    jQuery.data( this, key );
                });
            }
            var retValue;
            retValue = $.fn._data(key, value);
            if ('undefined' == (typeof retValue) || retValue.length == 0) {
                var nakedElem = this.get(0);
                if (nakedElem.hasOwnProperty('dataset')) {
                    if ('undefined' != (typeof nakedElem.dataset[key])) {
                        retValue = nakedElem.dataset[key];
                    }
                } else {
                    retValue = this.attr('data-'+key);
                }
            }
            return retValue;
        }
    });
})(jQuery);

All comments are gratefully received

On My Workbench at the moment is an update to the keyz jQuery plugin which adds all but the keychain functionality to the system. Also have been working on a multi page form component for Zend Framework.

Still working on working out the kinks in both before making a release.

Yesterday (May 4th — Star Wars Day .. lol) saw me sign the Zend Framwork Contributor License Agreement and send it off to Zend. Still no word as yet, but fingers crossed.

I’ve also bought myself an XBOX 360 (and a few games), you’ll find me on XBL as my usual nick.

Things seem to be going well at the moment, but only time will tell.

The Solution

The solution is to extend Zend_form and use the extended version as the basis for all the forms in the application. Here is my Form class.

<?php
class BinaryKitten_Form extends Zend_Form
{
    private $_stylesheets = array(
        'main'=>array('href'=>'/css/form.css', 'media'=>'screen')
    );

    public function addStylesheet($href,$media='screen')
    {
        $this->_stylesheets[basename($href)] = array(
            "href"=>$href,
            "media"=>$media
        );
    }

    public function removeStylesheet($href)
    {
        unset($this->_stylesheets[basename($href)]);
    }

    public function clearStylesheets()
    {
        $this->_stylesheets = array();
    }

    public function render(Zend_View_Interface $view = null)
    {
        if (null !== $view) {
            $this->setView($view);
        }
        else {
            $view = $this->getView();
        }

        foreach ($this->_stylesheets as $stylesheet) {
            $view->headLink()->appendStylesheet($stylesheet['href'], $stylesheet['media']);
        }

        $content = '';
        foreach ($this->getDecorators() as $decorator) {
            $decorator->setElement($this);
            $content = $decorator->render($content);
        }
        return $content;
    }
}

Of course you would extend it as usual to create a new form….

<?php
class BinaryKitten_Form_LoginForm extends BinaryKitten_Form
{
    public function __construct($option = null)
    {
        parent::__construct($option);
        $decorators = array(
            array('ViewHelper'),
            array('Label', array(
                'requiredSuffix'=>" *"
            )),
            array('HtmlTag', array('tag'=>'div'))
        );

        $username = new Zend_Form_Element_Text('username');
        $username
            ->setLabel('Username')
            ->setRequired(true)
            ->addValidator('NotEmpty', true)
            ->addFilter("StringTrim")
            ->addErrorMessage('Please Enter your Username')
            ->setDecorators($decorators);

        $password = new Zend_Form_Element_Password('password');
        $password
            ->setLabel('Password')
            ->setRequired(true)
            ->addValidator('NotEmpty', true)
            ->addFilter("StringTrim")
            ->addErrorMessage('Please Enter your Password')
            ->setDecorators($decorators);

        $loginButton = new Zend_Form_Element_Submit('login');
        $loginButton
            ->setValue('login');

        $this
            ->addElements(
                array(
                    $username,
                    $password,
                    $loginButton
                )
            )
            ->setMethod('post')
            ->setName('loginForm')
            ->addDecorator(
                array('mytag' => 'HtmlTag'), array('tag' => 'div')
            )
            ->removeDecorator('HtmlTag');

        $this->addStylesheet('/css/loginform.css','screen');
    }
}

And then as usual in you controller:

$form = new BinaryKitten_Form_LoginForm();
$this->view->form = $form;

and of course, echo it out in the view
[sourcecoe lang="php"]
echo $this->form;
[/sourcecode]

And that’s it, Simple.
Hopefully this will help someone out there

Usage

It’s as easy as these steps:

1. Include jquery – either from CDN or local source
2. Include jquery.keyz.js
3. call the following within your document ready or after the item exists

$('selector').keyz({
"enter": function(ctl,sft,alt,event) {
alert('you pressed enter!');
}
});

this will hook the enter key and raise an alert when pressed.

If you want to cancel the key either return false from the function or set the value to false like so:

$('selector').keyz({
"enter": function(ctl,sft,alt,event) {
return false;
}
});

OR

$('selector').keyz({
"enter":false
});

You can either use the key names in singular or in a grouping like so:

$('selector').keyz({
"enter": function(ctl,sft,alt,event) {
/* single key */
return false;
},
"F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12": function(ctl,sft,alt,event) {
/* mapped to all F-Keys */
return false;
}
});

Download jquery.keyz.js here: Full Source && Google Closure Compiled version

Visit the demo page here: Full Source

Planned Features

• support for keypress chains .. passing a sequence of keys and an event firing upon completion
• support for all three key states – presently only triggers on key down – Added in 1.0.2
• to add some duck punching to add the keyname to the event for the three standard events

Supported Keys

The keys listed below are the current ones supported by the plugin.
They also support the hyphenated name eg numpad-1 or in upper case like “F1″ or “f1″

• enter
• return
• esc
• escape
• numerics
• upper
• lower
• alphanumeric
• tab
• shift
• alt
• ctrl
• f1
• f2
• f3
• f4
• f5
• f6
• f7
• f8
• f9
• f10
• f11
• f12
• caps
• capslock
• numlock
• winflag
• winkey
• windows
• scrolllock
• left
• up
• right
• down
• volumeup
• volumedown
• menu
• contextmenu
• backspace
• pause
• break
• pausebreak
• pageup
• pagedown
• end
• home
• insert
• del
• delete
• numpad0
• numpad1
• numpad2
• numpad3
• numpad4
• numpad5
• numpad6
• numpad7
• numpad8
• numpad9
• *
• multiply
• +
• add
• -
• subtract
• .
• fullstop
• decimal
• /
• divide
• ;
• semicolon

Setting up Pear

Since I will be using Pear to install the code sniffer we might as well cover that to start with.
There are lots of tutorials out there with the aim of helping you to get pear installed no matter what the platform. I Will leave that job for them. What I will do is cover how to get it running easily with WampServer from http://www.wampserver.com/en/ Please do Note that this is all on a Windows Based machine

1. Open a command prompt
2. Make a note of your php Directory… you will need this in a few places
   “WAMPDIR\bin\php\PHPVERSION”
   where WAMPDIR = the directory WampServer is installed to
   and PHPVERSION = php+version number..
   i’m using php 5.2.11 on wampserver so the location for me looks like this
   “D:\Wamp\bin\php\php5.2.11″
3. CD /D PHPDIR – where PHPDIR is the location you should have noted down in the last step
4. Type go-pear and watch as it installs
5. bring up the Advanced system properties
6. Environment Variables
7. Edit Path to add your php folder prefixed with a ;
   e.g. for my path was already c:\SharedLibs so that became
   c:\SharedLibs;d:\wamp\bin\php\php5.2.11 – Close and save all settings

Installing PHP_CodeSniffer via Pear

Now that I had pear installed I could use it to install PHP_CodeSniffer, this was a simple task with 1 line of code..
pear install PHP_Codesniffer and that was it.. Actually I tell a small lie here, to make it work within the confines of other folders was to do as follows:

1. Open the phpcs.bat file that resides in the php folder outlined above in notepad or similar editor
2. Change “./php.exe” to “php.exe”, save the file and close

Now we are ready to run PHP_Codesniffer.

Setting up Komodo Edit

To start with, I use Komodo Edit for this, that is because that is what I use. I thoroughly recommend it over the likes of notepad++ etc mainly because of its feature set, and the way that it handles code completion from the project. But enough of all this, lets get down to creating a “run Command” for the active Tab/File in Komodo.

1. Click Tools, then Run Commandin the Run box enter the following:
2. phpcs -n --standard=%(ask:Which Standard do you wish to use?:ZEND) --report=emacs "%F"Check the Add to Toolbox optionToggle the More options So you can see the Advanced Options Panemake sure the “Run in” is set to Command Output TabCheck the “Parse Output with:” checkbox and enter the following in the select field:

   ^(?P<file>.*):(?P<line>\d+):(?P<column>\d+):(?P<content>.*)
                        

3. Check the “Show parsed output as a list” checkbox
4. Click the New button to begin adding a envrionment variable
5. Set the “Variable Name” to PATH and the “Variable Value” to the location of PHP_Codesniffer – If you are following through this is the same as step 2 of “setting up pear”- then click ok
6. click Run button – PHP_CodeSniffer will run and then will ask you for the standard you wish to check against .. by default It’s set to ZEND
7. Lastly right click the toolbox entry and bring up the properties. The Top left Text entry is the “nice name” for this. You can also assign keys to launch this command later

Now you have successfully created a run Tool in Komodo that will run PHP_Codesniffer against the active file and will output the results in a nice list in the command output tab at the bottom panel. I chose the emacs output method as it was easier to get nice looking format without the \” escape sequence appearing in the “content”. The Reason for the regex and the list is that it will now allow you to double click and entry and it will jump to the right spot in the file.

I’ve also included a Komodo Package of 3 run time commands .. 1 for file, 1 for all files in the project and 1 for all files the directory shared with the currently active file. You can download them here: CodeSniff Package – Recommended to Right-Click – Save Target as etc – This packages comes with predefined keystrokes

• CTRL+L,CTRL+S,CTRL+F to Codesniff the currently Active file
• CTRL+L,CTRL+S,CTRL+P to Codesniff all files in the Project
• CTRL+L,CTRL+S,CTRL+D to Codesniff all files in the Active File’s Directory

I do hope that this will prove as useful for someone else as it has for me, comments are welcome.