[[toc]]

• Horde_View

Documentation on the Horde_View package. This documentation is adopted from the MAD documentation (http://framework.maintainable.com/mvc/5_view.php), as many of the Horde View ideas are also adopted from MAD, and the helpers are directly compatible between the two systems.

++ Example usage

Calling code

<tr>

    <th>Author</th>

    <th>Title</th>

</tr>

<tr>

</tr>

<p>There are no books to display.</p>

++ Base functionality

• assign indiv vars

• assign bulk vars

• __isset/__empty/__get

• add template paths (incl. add missing trailing slash)

• render (w/ .html added if no extension)

• render in path order

• render partials

• render w/ local variables

• render partial collections

• add helpers

• helper method overwrite

++ Helper functionality

+++ Benchmark

• logging

+++ Capture

• capture output (nested output buffers)

• capture to named view variable

+++ Debug

• pretty variable dump

+++ Form Tag

• generate form tags

• generate multipart form tags

• checkbox input

• hidden input

• file input

• password input

• radio input

• select input

• textarea input

• text field input

• submit input

+++ Form

• initialize defaults from objects

• wrapper around FormTag helpers with object awareness

• formFor($object)

• fieldsFor($object)

• default form builder

• custom form builders

+++ Javascript

• generate <script> tags

+++ Number

• human-readable file sizes

+++ Tag

• xhtml tags with programmatic options

• rewrite checked => true to checked="checked"

• contentTag for tags with nested content

• generate CDATA sections

• single-escaping to not re-escape entities

+++ Text

• h() shorthand escape

• truncate

• truncate middle

• highlight

• cycle

• pluralize

+++ Url

• linkTo, either from controller-generated links or string URIs

• default to showing URL as link text

• linkToUnless

• linkToIf

• mailTo

• mailTo with javascript email address obfuscation

• mailTo with hex email address obfuscation

• mailTo with "replace this ..." obfuscation

++ Helpers

+++ Overview

Views separate the presentation from the controllers and models. Views are allowed to have logic, provided that the logic is only for presentation purposes. This presentation logic is small bits of PHP code embedded in the HTML.

Bits of presentation logic code can be extracted into helper methods. Once extracted, a helper method can be called in the view in place of the former code block. Extracting presentation logic into helpers is a best practice and helps keep views clean and DRY.

Helpers are simply methods of a class. The framework mixes the helpers into the view behind the scenes, and makes them appear as methods inside the view. An example of a helper class with a single {{highlight()}} helper follows:

/**

 * Highlight a phrase within the given text

 * @param   string  $text

 * @param   string  $phrase

 * @return  string

 */

public function highlight($text, $phrase)

{

    $escaped = $this->h($text);

    $highlighter = '<strong class="highlight">$excaped</strong>';



    if (empty($phrase) || empty($text)) {

        return $text;

    }

    return preg_replace("/($phrase)/", $highlighter, $text);

}

And in the HTML template: