So I’ve created this small shipping calculator. It’s set to use KG in weight and prices inclusive of vat taken from the Royal Mail’s 2011 Prices.

Follows are the config ini file, the class and a basic usage.

[EUR]
prices[0.01] =1.79
prices[0.12] =1.94
prices[0.14] =2.15
prices[0.16] =2.32
prices[0.18] =2.54
prices[0.2] =2.63
prices[0.22] =2.75
prices[0.24] =2.87
prices[0.26] =2.99
prices[0.28] =3.08
prices[0.3] =3.14
prices[0.32] =3.8
prices[0.42] =4.46
prices[0.52] =5.12
prices[0.62] =5.78
prices[0.72] =6.44
prices[0.82] =7.1
prices[0.92] =7.76
prices[1] =7.76

above.start = 1.1
above.increment = 0.1
above.valuePerIncrement = 0.55

[ITL]
prices[0.01] =2.49
prices[0.12] =2.79
prices[0.14] =3.12
prices[0.16] =3.48
prices[0.18] =3.84
prices[0.2] =4.2
prices[0.22] =4.56
prices[0.24] =4.76
prices[0.26] =4.88
prices[0.28] =5
prices[0.3] =5.12
prices[0.32] =6.45
prices[0.42] =7.78
prices[0.52] =9.11
prices[0.62] =10.44
prices[0.72] =11.78
prices[0.82] =13.11
prices[0.92] =14.44
prices[1] =14.44

above.start = 1.1
above.increment = 0.1
above.valuePerIncrement = 0.66

[UK]
prices[0.1] =1.9
prices[0.25] =2.36
prices[0.5] =2.98
prices[0.75] =3.66
prices[1] =4.46
prices[1.25] =5.88
prices[1.5] =6.8
prices[1.75] =7.71
prices[2] =8.62
prices[4] =10.74

above.start = 6
above.increment = 2
above.valuePerIncrement = 3.66

<?php
class BinaryKitten_Shipping {
    private $_cfg;
    private $_curCfg;
    public function __construct($postalZone=null) {
        $this->_curCfg = $this->_cfg = new Zend_Config_Ini(APPLICATION_PATH .'/configs/postal.ini');
        if (isset($postalZone)) {
            $this->setPostalZone($postalZone);
        }
    }
    public function setPostalZone($postalZone)
    {
        if (self::validatePostalZone($postalZone)) {
            $this->_curCfg = $this->_cfg->get($postalZone, $this->_cfg);
        }

    }
    public static function validatePostalZone($postalZone)
    {
        return in_array(strtoupper($postalZone), array('UK','EUR','ITL'));
    }
    public function getPriceForWeight($weight)
    {
        $priceOut = -1;
        foreach($this->_curCfg->prices as $weightBoundary=>$price) {
            if ($weightBoundary < $weight) continue;
            if ($weightBoundary >= $weight) {
                $priceOut = $price;
                break;
            }
        }
        if ($priceOut == -1) {
            for($weightBoundary = (float)$this->_curCfg->above->start;$weightBoundary < $weight;$weightBoundary += $this->_curCfg->above->increment) {
                $price+=$this->_curCfg->above->valuePerIncrement;
            }

            $priceOut = $price;
            //try to calculate the difference
        }
        return (float)$priceOut;
    }
}

$prices = new BinaryKitten_Shipping();
$prices->setPostalZone('EUR');
$price = $prices->getPriceForWeight(5);

This works well, but I wanted to make sure that the plugn was not accessible unless the user logged in. I already used Zend_Auth and this doesn’t exactly play well with the basic SessionAuthenticator. So I set out to create a basic simple plugin for TinyMCE that would allow it to work with the Zend_Auth System.

- Creating the plugin -
first off we have to create our plugin and plugin folder within the tinymce plugin’s plugin folder. If you think that’s a lot of use of plugin, you can understand where my brain decided to up and leave.

1st locate your tinymce folder, in there you should find plugins and then go into the filemanager folder. Of course this assumes you have purchased and installed the filemanager plugin. Your path should be something like the following:
<path_to_tiny_mce>/plugins/filemanager/ – this is what we shall refer to our “Base Path” from now on.

now we are at a comfortable location to proceed, we can go ahead and create our folder and file
<Base Path>/plugins/ZendAuthenticator
in here place a file name ZendAuthenticator.php containing this code:

<?php
/**
 * Use Zend_Auth to validate the logged in user.
 *
 * @author BinaryKitten
 */
class BinaryKitten_ZendAuthenticator extends Moxiecode_ManagerPlugin {

    private $auth = null;
    public function  __construct($man)
    {
        $config = $man->getConfig();
        if (isset($config['ZendAuthenticator.LibraryPath']) && !empty($config['ZendAuthenticator.LibraryPath'])) {
            set_include_path(
                implode(
                    PATH_SEPARATOR, array(
                        realpath(
                        $config['ZendAuthenticator.LibraryPath']
                        ),
                        get_include_path(),
                    )
                )
            );
        }
        require "Zend/Auth.php";
        $this->auth = Zend_Auth::getInstance();
    }

    //put your code here
    public function onAuthenticate(&$man)
    {
        return $this->auth->hasIdentity();
    }
}

$man->registerPlugin("ZendAuthenticator", new BinaryKitten_ZendAuthenticator($man));

Voila the plugin is ready.

- Configuring the plugin -
Now open up the config.php found in the “Base Path” mentioned earlier.
locate: $mcFileManagerConfig['authenticator'] and set it’s value to the following
$mcFileManagerConfig['authenticator'] = 'ZendAuthenticator';

- Library Location -

Finally, If your Zend_Framework is not located on the include path (like mine is) then you will need to tell the system where to find the library, to do this add the following to the config.php
$mcFileManagerConfig['ZendAuthenticator.LibraryPath'] = ' ';
Please remember though that this is relative to the “Base Path” and not the Document_Root unless you specify it as such.

– - – - –
The last thing I will leave you with is that this only checks to see if there is a stored session for Zend_Auth. I’ll leave it up to you if you want to get roles and other fancy stuff integrated.

I came, I saw and a I tested.
A good test fest for PHP and my 1st. I managed to get two tests complete.. mainly because of my inability to follow instructions

anyway was all good and great to see so many people there.

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!

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