While working through our first project we ran into issues with this structure of forms.  I didn’t run into any problems but in order to stop the complaints from the designers in our office I decided to work on getting Zend Form to generate forms in the style laid out at A List Apart.

I didn’t figure this would really be all that difficult because most of the documentation for Zend Framework fairly good.  Little did I know that the documentation and examples for Zend Form with Zend Config were fairly hard to find.  When I did find documentation the decorators stilled confused me for a while.  Then everything just seemed to click one day and I was successful in getting exactly what I wanted.  Now I don’t have designers complaining anymore because they have forms structured exactly the way they want(Sorry Rob ).  In order to get the results I wanted I ended up with a form defined in my ini file like the following:

[signInForm]
form.id = "signInForm"
form.method = "post"
form.action = "/sign-in/"

; Form Decorators
form.disableLoadDefaultDecorators = true
form.decorators.formElements.decorator = "FormElements"
form.decorators.description.decorator = "Description"
form.decorators.form.decorator = "Form"

; Global Element Decorators
form.elementDecorators.decorator = "ViewHelper"
form.elementDecorators.error.decorator = "Errors"
form.elementDecorators.description.decorator = "Description"
form.elementDecorators.label.decorator = "Label"
form.elementDecorators.formElements.decorator = "HtmlTag"
form.elementDecorators.formElements.options.tag = "li"

; Group Decorators
form.displayGroupDecorators.decorator = "FormElements"
form.displayGroupDecorators.formElements.decorator = "HtmlTag"
form.displayGroupDecorators.formElements.options.tag = "ol"
form.displayGroupDecorators.fieldset.decorator = "Fieldset"

; Form Groups
form.displayGroups.signinGroup.elements.username    = "username"
form.displayGroups.signinGroup.elements.password    = "password"
form.displayGroups.signinGroup.elements.rememberMe  = "rememberMe"

form.displayGroups.submitGroup.elements.submit = "submit"

; username element
form.elements.username.type = "text"
form.elements.username.options.validators.notempty.validator = "NotEmpty"
form.elements.username.options.validators.notempty.breakChainOnFailure = true
form.elements.username.options.validators.strlen.validator = "StringLength"
form.elements.username.options.validators.strlen.options.min = 6
form.elements.username.options.validators.strlen.options.max = 20
form.elements.username.options.required = true
form.elements.username.options.label = "Username:"

; password element
form.elements.password.type ="password"
form.elements.password.options.validators.notempty.validator = "NotEmpty"
form.elements.password.options.validators.notempty.breakChainOnFailure = true
form.elements.password.options.validators.strlen.validator = "StringLength"
form.elements.password.options.validators.strlen.options.min = "6"
form.elements.password.options.required = true
form.elements.password.options.label = "Password:"

; remember me element
form.elements.rememberMe.type = "checkbox"
form.elements.rememberMe.options.label = "Remember Me?"

; login button element
form.elements.submit.type = "button"
form.elements.submit.options.name = "SignIn"
form.elements.submit.options.value = "Sign In"
form.elements.submit.options.label = "Sign In"

I hope this helps someone else as I could not find a good solid example of how to get this working. If anyone has any feedback on a better way of handling this let me know in the comments.
Thanks,
Chris

Update
I updated “FieldSet” to “Fieldset” as that has changed since I wrote this post.  Thanks for the message about the error!
Chris

The following is probably revision 2 of the original idea. I realized after writing it the first time I should have made it more generic so I could use it on multiple fields without changing anything except the properties in the config ini for each form field.

To add the validator to a field using Zend Config you would do the following:

        form.elements.email.options.validators.uniqueField.validator = "uniqueField"
        form.elements.email.options.validators.uniqueField.options.modelName = "Notification"
        form.elements.email.options.validators.uniqueField.options.fieldname = "notification_email"

< ?php
class Robyn_Validate_UniqueField extends Zend_Validate_Abstract
{
    /**
     * @var String
     */
    const NOT_UNIQUE = 'error';

    /**
     * @var String
     */
    protected $_modelName = 'User';

    /**
     * @var String
     */
    protected $_fieldName = 'user_username';

    /**
     * @var array
     */
    protected $_messageTemplates = array(
                                         self::NOT_UNIQUE => 'The data given is not unique.'
                                         );

    /**
     * Sets validator options
     *
     * @param  string $modelName
     * @param  string $fieldName
     * @return void
     */
    public function __construct($modelName = 'User', $fieldName = 'user_username')
    {
        $this->setModelName($modelName);
        $this->setFieldName($fieldName);
    }

    /**
     * Defined by Zend_Validate_Interface
     *
     * Returns true if and only if the email address is found to NOT have a match in the fieldname in the model specified
     *
     * @param Array $value
     * @param Array $request
     * @return boolean
     */
    public function isValid($value, $request = null)
    {
        // Set the value
        $value = (string) $value;
        $this->_setValue($value);

        // Get our model and do a search for that username
        $table = new $this->_modelName();
        $result = $table->fetchAll($table->select()->where($this->_fieldName . ' = ?', $value))->toArray();

        // Check to see if we got any results
        if (count($result) == 0) {
            return true;
        }

        $this->_error(self::NOT_UNIQUE);
        return false;
    }

    /**
     * Set the model name.
     *
     * @param string $modelName
     * @return Zend_Validate_UniqueUsername Provides a fluent interface
     */
    public function setModelName($modelName)
    {
        $this->_modelName = $modelName;

        return $this;
    }

    /**
     * Set the field name.
     *
     * @param string $fieldName
     * @return Zend_Validate_UniqueUsername Provides a fluent interface
     */
    public function setFieldName($fieldName)
    {
        $this->_fieldName = $fieldName;

        return $this;
    }
}

The modifications were pretty basic in that the code was tracking ALL requests and there are a few requests that I did not want to track(namely Ajax and page reloads).  By not tracking these requests I feel I get a much more accurate representation of the path the user is following through the application.  The one thing I am still yet to conquer is how to find out if a requests is triggering a 404 page and if so to not track it.  I’m not sure that it is even possible because of when the helper is triggered but I haven’t delved very deep either(just something I want to put in at some point but if you know how let me know in the comments).So without further ado the code:

<?php
Zend_Loader::loadClass('Zend_Controller_Action_Helper_Abstract');
Zend_Loader::loadClass('Zend_Controller_Action_HelperBroker');
Zend_Loader::loadClass('Zend_Session_Namespace');
/**
* This helper tracks the user's browsing history
*
* @copyright 2008 Jani Hartikainen <www.codeutopia.net>
* @author Jani Hartikainen <firstname at codeutopia net>
* @author Chris Antoine <chris@spinweb.net>(Modifications)
*/
class SoulOpinion_Action_Helper_History extends Zend_Controller_Action_Helper_Abstract
{
/**
* @var Zend_Session_Namespace
*/
private $_namespace;

/**
* How many history URLs to track?
*
* @var int
*/
private $_trackAmount = 0;

/**
* Track Ajax Requests?
*
* @var int
*/
private $_ajax = 0;

/**
* Current URL
*
* @var string
*/
private $_currentUrl = null;

/**
* @param int $trackAmount [optional] How many history URLs to track
*/
public function __construct($trackAmount = 5)
{
$this->setTrackAmount($trackAmount);

$this->_initSession();
}

/**
* Initialize the history from session
*/
private function _initSession()
{
$this->_namespace = new Zend_Session_Namespace('Zend_Controller_Action_Helper_History');

// Break out if we don't want to track the request
if ($this->trackableRequest() == false) {
return true;
}

if (!is_array($this->_namespace->history)) {
$this->_namespace->history = array();

if(!empty($_SERVER['HTTP_REFERER'])) {
array_unshift($this->_namespace->history, $_SERVER['HTTP_REFERER']);
}
} else {
array_splice($this->_namespace->history, $this->_trackAmount);
}
}

public function preDispatch()
{
$urlHelper = Zend_Controller_Action_HelperBroker::getStaticHelper('Url');
$this->_currentUrl = $urlHelper->url();

// Break out if we don't want to track the request
if ($this->trackableRequest() == false) {
return true;
}

if (!is_array($this->_namespace->history)) {
$this->_namespace->history = array();
}

array_unshift($this->_namespace->history, $this->_currentUrl);
}

/**
* Set how many history URLs to track
*
* @param int $trackAmount
*/
public function setTrackAmount($trackAmount)
{
$this->_trackAmount = $trackAmount;
}

/**
* Redirects the browser back in history
*
* @param int $amount How many URLs to go back
*/
public function goBack($amount = 1)
{
Zend_Controller_Action_HelperBroker::getStaticHelper('Redirector')
->setPrependBase(false)
->gotoUrl($this->_namespace->history[$amount]);
}

/**
* Returns an URL from history
*
* @param int $amount How many URLs to go back
* @return string
*/
public function getPreviousUrl($amount = 1)
{
return $this->_namespace->history[$amount];
}

/**
* Return all previous URLs
*
* @return array
*/
public function getArray()
{
return $this->_namespace->history;
}

public function getName()
{
return 'History';
}

/**
* Validate that we want to track the request
*
* @return Boolean
*/
private function trackableRequest()
{
// Decide whether or not we should track Ajax Requests
if ($this->_ajax == 0) {
Zend_Loader::loadClass('Zend_Controller_Request_Http');
$request = new Zend_Controller_Request_Http();

if ($request->isXmlHttpRequest()) {
return false;
}
}

// Now we are going to verify the user didn't just reload the page or click the same link.
// No reason to track page reloads.
if ($this->_currentUrl == $this->_namespace->history[0]) {
return false;
}

// Need to come up with a way to check for a 404 error so we don't track bad requests.

return true;
}
}

While looking at using the Zend Framework for our work at SpinWeb I came across the coding standards and realized there are a lot of benefits to having someone else set the standards. Just one example is there are less discussions on the “right” way and we can make small modifications if we all agree but otherwise we just live with the standards that Zend has laid out.

What I have come realize is that even while I was always trying to follow my own standards I would always stretch them when I was in a hurry or something else had my attention and since they were my own standards it wasn’t that big of a deal[for some reason]. I’ve been doing my best to follow the Zend Coding Standards for a couple months now and everything has really become habit and I find myself really pushing myself more and more to follow the standards.

If you run into the same types of issues or just want more “official” standards Zend has a nice start.

Zend Coding Standard
Zend Framework
SpinWeb, Inc.

   
function print_r(theObj){
   if(theObj.constructor == Array || theObj.constructor == Object){
      document.write("<ul>")
      for(var p in theObj){
         if(theObj[p].constructor == Array || theObj[p].constructor == Object){
            document.write("<li>["+p+"] => "+typeof(theObj)+"</li>");
            document.write("<ul>")
            print_r(theObj[p]);
            document.write("</ul>")
         } else {
            document.write("<li>["+p+"] => "+theObj[p]+"</li>");
         }
      }
      document.write("</ul>")
   }
}
 

Its a pretty simple little snippet of code but was VERY handy for me while troubleshooting an event problem and having to deal with each individual browser as each of them have different event properties. Hope it helps someone else.

I’d like my postings to be condensed with some type of “Read More” link at the bottom to expand them for reading

Having an additional link to “read more” in your WordPress posting is a great idea for a couple of reasons.

The first reason is a matter of preference. By default, WordPress will use the built in function of “the_content”, which is located in at least one file in your default theme directory, the homepage file which is the “index.php” file. What this means is that WordPress will show full posts, with the title being a link to the full post in the “single.php” where a user can comment on your post and see other additional information. If you don’t make any to the default theme, WordPress will show something like 10 posts on your homepage, and depending on your ability to write concisely:) you can have a long scrolling page. This is a preference, some people don’t mind this, others really don’t like it at all.

The second reason, and the more important reason for having “excerpts” is for search engine reasons. Google doesn’t like duplicate content, within a site, or one website that has plagerized another. You have the possibility of being black listed for blantant obvious violations. So, using the power of having an “excerpt” allows you to either write a custom hook for your homepage to lure in readers to the article, or you can just insert a tag to use a portion of the already written post as the hook.

How to change your theme to use excerpts

Again, in the post gui, you have a “more” button that you can insert some text called “” and this will automatically cut off your post and make an excerpt for you. But, if you would like to option to not have to remember to add that snippet of code every time you post, and have the excerpts happen automatically, you set that up by modifying your theme. Open up your index.php file in your default theme folder and look at approximately line 14 where you will see this code inside the php tags;

php the_content(‘Read the rest of this entry »’);

Change that line to read this instead;

php the_excerpt();

More information about this template tag / function / class or whatever you want to call it:) is located in the WordPress codex on the_excerpt (which is a programmers term for code manual).

How I use excerpts on my blog

I wasn’t satisfied with the fuction that the WordPress developers provide. The problem I had with the_excerpt, is that it strips html. So your posts will look like a non-formatted, run on mess. I felt like strongly about being as customizable as possible, and frankly, more professional as a designer. I don’t know much about php, so I wouldn’t be able to hack the core code. Besides, I wouldn’t want to, because my changes would have to ported over each time I upgraded my version of WordPress.

So, I found a great little plugin for WordPress that allows me to format my excerpts all I like. It’s called The Excerpt Reloaded, and it let’s you set a ton of options like excerpt length, the name of your “read more” link, the allowed html in the excerpt and more.

Here is a screenshot from Rotheblog showing how I have been able to use both div’s and images and other formatting in my excerpts to make the hook for the post really appealing;

Make sure to use version R1.4, and not R1.1. Version R1.1 had issues where it wouldn’t close the allowed tags which would then close a tag in the layout of the site and break the visual look. Fortunately another developer took over and made those changes, but you will want to look at the original Excerpt Reloaded page to see all the template tag parameters for setting up your excerpt.

Questions? Comments?

Leave a comment. Has anyone modified the code base for WordPress to leverage the_excerpt template tag to do the same thing as the plugin? I’d love to hear about it if you have.