Detailed Description
Definition at line 30 of file Layout.php.
Constructor & Destructor Documentation
__construct |
( |
$ |
options = null , |
|
|
$ |
initMvc = false |
|
) |
| |
Constructor
Accepts either:
- A string path to layouts
- An array of options
- A Zend_Config object with options
Layout script path, either as argument or as key in options, is required.
If mvcEnabled flag is false from options, simply sets layout script path. Otherwise, also instantiates and registers action helper and controller plugin.
- Parameters:
-
- Returns:
- void
Definition at line 142 of file Layout.php.
Member Function Documentation
Get layout variable
- Parameters:
-
- Returns:
- mixed
Definition at line 701 of file Layout.php.
Is a layout variable set?
- Parameters:
-
- Returns:
- bool
Definition at line 716 of file Layout.php.
Set layout variable
- Parameters:
-
- Returns:
- void
Definition at line 690 of file Layout.php.
Unset a layout variable?
- Parameters:
-
- Returns:
- void
Definition at line 727 of file Layout.php.
_initHelper |
( |
) |
[protected] |
Initialize action helper
- Returns:
- void
Definition at line 286 of file Layout.php.
Initialize MVC integration
- Returns:
- void
Definition at line 252 of file Layout.php.
_initPlugin |
( |
) |
[protected] |
Initialize front controller plugin
- Returns:
- void
Definition at line 263 of file Layout.php.
_initVarContainer |
( |
) |
[protected] |
_setMvcEnabled |
( |
$ |
mvcEnabled ) |
[protected] |
assign |
( |
$ |
spec, |
|
|
$ |
value = null |
|
) |
| |
Assign one or more layout variables
- Parameters:
-
mixed | $spec | Assoc array or string key; if assoc array, sets each key as a layout variable |
mixed | $value | Value if $spec is a key |
- Returns:
- Zend_Layout
- Exceptions:
-
Zend_Layout_Exception | if non-array/string value passed to $spec |
Definition at line 743 of file Layout.php.
Retrieve content key
- Returns:
- string
Definition at line 450 of file Layout.php.
Retrieve helper class
- Returns:
- string
Definition at line 516 of file Layout.php.
Retrieve inflector
- Returns:
- Zend_Filter_Inflector
Definition at line 637 of file Layout.php.
Retrieve inflector target
- Returns:
- string
Definition at line 603 of file Layout.php.
Get current layout script
- Returns:
- string
Definition at line 349 of file Layout.php.
Get current layout script path
- Returns:
- string
Definition at line 426 of file Layout.php.
Retrieve MVC enabled flag
- Returns:
- bool
Definition at line 472 of file Layout.php.
static getMvcInstance |
( |
) |
[static] |
getMvcSuccessfulActionOnly |
( |
) |
|
Get MVC Successful Action Only Flag
- Returns:
- bool
Definition at line 494 of file Layout.php.
Retrieve plugin class
- Returns:
- string
Definition at line 538 of file Layout.php.
Retrieve layout view script suffix
- Returns:
- string
Definition at line 593 of file Layout.php.
Return status of inflector enabled flag
- Returns:
- bool
Definition at line 678 of file Layout.php.
Is layout enabled?
- Returns:
- bool
Definition at line 381 of file Layout.php.
Render layout
Sets internal script path as last path on script path stack, assigns layout variables to view, determines layout name using inflector, and renders layout view script.
$name will be passed to the inflector as the key 'script'.
- Parameters:
-
- Returns:
- mixed
Definition at line 773 of file Layout.php.
static resetMvcInstance |
( |
) |
[static] |
Reset MVC instance
Unregisters plugins and helpers, and destroys MVC layout instance.
- Returns:
- void
Definition at line 205 of file Layout.php.
setContentKey |
( |
$ |
contentKey ) |
|
Set content key
Key in namespace container denoting default content
- Parameters:
-
- Returns:
- Zend_Layout
Definition at line 439 of file Layout.php.
setHelperClass |
( |
$ |
helperClass ) |
|
setInflector |
( |
Zend_Filter_Inflector $ |
inflector ) |
|
Set inflector to use when resolving layout names
- Parameters:
-
Zend_Filter_Inflector | $inflector | |
- Returns:
- Zend_Layout
Definition at line 626 of file Layout.php.
setInflectorTarget |
( |
$ |
inflectorTarget ) |
|
setLayout |
( |
$ |
name, |
|
|
$ |
enabled = true |
|
) |
| |
Set layout script to use
Note: enables layout by default, can be disabled
- Parameters:
-
string | $name | |
boolean | $enabled | |
- Returns:
- Zend_Layout
Definition at line 335 of file Layout.php.
setMvcSuccessfulActionOnly |
( |
$ |
successfulActionOnly ) |
|
Set MVC Successful Action Only flag
- Parameters:
-
bool | $successfulActionOnly | |
- Returns:
- Zend_Layout
Definition at line 483 of file Layout.php.
Set options en masse
- Parameters:
-
- Returns:
- void
Definition at line 230 of file Layout.php.
setPluginClass |
( |
$ |
pluginClass ) |
|
setViewSuffix |
( |
$ |
viewSuffix ) |
|
static startMvc |
( |
$ |
options = null ) |
[static] |
Static method for initialization with MVC support
- Parameters:
-
- Returns:
- Zend_Layout
Definition at line 173 of file Layout.php.
The documentation for this class was generated from the following file:
- E:/E/GEAMP/www/openbiz/openbiz/others/Zend/Layout.php