View/Interface.php

Show: PublicProtectedPrivateinherited
    Table of Contents
    Zend Framework

    LICENSE

    This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_View  
    Version
    $Id: Interface.php 24593 2012-01-05 20:35:02Z matthew $  

    \Zend_View_Interface
    jump to top

    Package: Zend\View
    Interface class for Zend_View compatible template engine implementations
    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublic__isset(string $key) : boolean

    Allows testing with empty() and isset() to work

    Parameters
    NameTypeDescription
    $keystring
    Returns
    TypeDescription
    boolean
    methodpublic__set(string $key, mixed $val) : void

    Assign a variable to the view

    Parameters
    NameTypeDescription
    $keystring

    The variable name.

    $valmixed

    The variable value.

    methodpublic__unset(string $key) : void

    Allows unset() on object properties to work

    Parameters
    NameTypeDescription
    $keystring
    methodpublicaddBasePath(string $path, string $classPrefix = 'Zend_View') : void

    Add an additional path to view resources

    Parameters
    NameTypeDescription
    $pathstring
    $classPrefixstring
    methodpublicassign(string | array $spec, mixed $value = null) : void

    Assign variables to the view script via differing strategies.

    Suggested implementation is to allow setting a specific key to the specified value, OR passing an array of key => value pairs to set en masse.

    Parameters
    NameTypeDescription
    $specstring | array

    The assignment strategy to use (key or array of key => value pairs)

    $valuemixed

    (Optional) If assigning a named variable, use this as the value.

    Details
    See
    \__set()  
    methodpublicclearVars() : void

    Clear all assigned variables

    Clears all variables assigned to Zend_View either via assign() or property overloading (__get()/__set()).

    methodpublicgetEngine() : mixed

    Return the template engine object, if any

    If using a third-party template engine, such as Smarty, patTemplate, phplib, etc, return the template engine object. Useful for calling methods on these objects, such as for setting filters, modifiers, etc.

    Returns
    TypeDescription
    mixed
    methodpublicgetScriptPaths() : array

    Retrieve all view script paths

    Returns
    TypeDescription
    array
    methodpublicrender(string $name) : string

    Processes a view script and returns the output.

    Parameters
    NameTypeDescription
    $namestring

    The script name to process.

    Returns
    TypeDescription
    stringThe script output.
    methodpublicsetBasePath(string $path, string $classPrefix = 'Zend_View') : void

    Set a base path to all view resources

    Parameters
    NameTypeDescription
    $pathstring
    $classPrefixstring
    methodpublicsetScriptPath(string | array $path) : void

    Set the path to find the view script used by render()

    Parameters
    NameTypeDescription
    $pathstring | array

    The directory (-ies) to set as the path. Note that the concrete view implentation may not necessarily support multiple directories.

    Documentation was generated by phpDocumentor 2.0.0a12.