ClassInterface Zend_View_Interface

Description

Interface class for Zend_View compatible template engine implementations

  • copyright: Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /View/Interface.php (line 31)


	
			
Method Summary
 void addBasePath (string $path, [string $classPrefix = 'Zend_View'])
 void assign (string|array $spec, [mixed $value = null])
 void clearVars ()
 mixed getEngine ()
 array getScriptPaths ()
 string render (string $name)
 void setBasePath (string $path, [string $classPrefix = 'Zend_View'])
 void setScriptPath (string|array $path)
 boolean __isset (string $key)
 void __set (string $key, mixed $val)
 void __unset (string $key)
Methods
addBasePath (line 77)

Add an additional path to view resources

  • access: public
void addBasePath (string $path, [string $classPrefix = 'Zend_View'])
  • string $path
  • string $classPrefix
assign (line 118)

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.

void assign (string|array $spec, [mixed $value = null])
  • string|array $spec: The assignment strategy to use (key or array of key => value pairs)
  • mixed $value: (Optional) If assigning a named variable, use this as the value.
clearVars (line 128)

Clear all assigned variables

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

  • access: public
void clearVars ()
getEngine (line 42)

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.

  • access: public
mixed getEngine ()
getScriptPaths (line 59)

Retrieve all view script paths

  • access: public
array getScriptPaths ()
render (line 136)

Processes a view script and returns the output.

  • return: The script output.
  • access: public
string render (string $name)
  • string $name: The script script name to process.
setBasePath (line 68)

Set a base path to all view resources

  • access: public
void setBasePath (string $path, [string $classPrefix = 'Zend_View'])
  • string $path
  • string $classPrefix
setScriptPath (line 52)

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

  • access: public
void setScriptPath (string|array $path)
  • string|array $path: The directory (-ies) to set as the path. Note that the concrete view implentation may not necessarily support multiple directories.
__isset (line 94)

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

  • access: public
boolean __isset (string $key)
  • string $key
__set (line 86)

Assign a variable to the view

  • access: public
void __set (string $key, mixed $val)
  • string $key: The variable name.
  • mixed $val: The variable value.
__unset (line 102)

Allows unset() on object properties to work

  • access: public
void __unset (string $key)
  • string $key

Documentation generated on Thu, 01 Apr 2010 13:11:50 -0400 by phpDocumentor 1.4.3