API Documentation

Tool/Project/Provider/Layout.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tool  
subpackage
Framework  
version
$Id: Layout.php 24408 2011-08-26 22:05:35Z adamlundrigan $  

\Zend_Tool_Project_Provider_Layout

This is a convenience class.

At current it will return the request and response from the client registry as they are the more common things that will be needed by providers

Extends from
\Zend_Tool_Project_Provider_Abstract
Implements
\Zend_Tool_Framework_Provider_Pretendable
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tool  

Properties

Propertyprotectedstring  $_layoutPath= 'APPLICATION_PATH "/layouts/scripts/'

Layout path
Default valueAPPLICATION_PATH "/layouts/scripts/Details
Type
string

Methods

methodprotected_findProfileDirectory(  $projectDirectory = null,  $searchParentDirectories = true ) : void
Parameters
Name Type Description
$projectDirectory
$searchParentDirectories
methodprotected_getApplicationConfigResource(  $profile ) : void

Parameters
Name Type Description
$profile
methodprotected_getContentForContext(  $context,  $methodName,  $parameters ) : void
Parameters
Name Type Description
$context
$methodName
$parameters
methodprotected_getProfile(  $loadProfileFlag = self ) : \Zend_Tool_Project_Profile

Return the currently loaded profile

Inherited from: \Zend_Tool_Project_Provider_Abstract::_getProfile()
Parameters
Name Type Description
$loadProfileFlag
Returns
Type Description
\Zend_Tool_Project_Profile
methodprotected_hasProjectProviderDirectory(  $pathToProfileFile ) : void
Parameters
Name Type Description
$pathToProfileFile
methodprivate_loadContextClassesIntoRegistry( array $contextClasses ) : void

_loadContextClassesIntoRegistry() - This is called by the constructor so that child providers can provide a list of contexts to load into the context repository

Inherited from: \Zend_Tool_Project_Provider_Abstract::_loadContextClassesIntoRegistry()
Parameters
Name Type Description
$contextClasses array
methodprotected_loadProfile( bool $loadProfileFlag = self, string $projectDirectory = null, bool $searchParentDirectories = true ) : \Zend_Tool_Project_Profile

_getProject is designed to find if there is project file in the context of where the client has been called from.. The search order is as follows..

Inherited from: \Zend_Tool_Project_Provider_Abstract::_loadProfile()
  • traversing downwards from (PWD) - current working directory
    • if an enpoint variable has been registered in teh client registry - key=workingDirectory
    • if an ENV variable with the key ZFPROJECT_PATH is found
Parameters
Name Type Description
$loadProfileFlag bool Whether or not to throw an exception when no profile is found
$projectDirectory string The project directory to use to search
$searchParentDirectories bool Whether or not to search upper level direcotries
Returns
Type Description
\Zend_Tool_Project_Profile
methodprotected_loadProfileRequired( ) : \Zend_Tool_Project_Profile

Load the project profile from the current working directory, if not throw exception

Inherited from: \Zend_Tool_Project_Provider_Abstract::_loadProfileRequired()
Returns
Type Description
\Zend_Tool_Project_Profile
methodprotected_storeProfile( ) : void

This method will store the profile into its proper location

methodpubliccreateResource(  $profile,  $layoutName = layout ) : void
static

Parameters
Name Type Description
$profile
$layoutName
methodpublicdisable( ) : void

methodpublicenable( ) : void

methodpublicgetContextClasses( ) : void
methodpublicinitialize( ) : void
methodpublicsetRegistry( \Zend_Tool_Framework_Registry_Interface $registry ) : \Zend_Tool_Framework_Provider_Abstract

setRegistry() - required by Zend_Tool_Framework_Registry_EnabledInterface

Inherited from: \Zend_Tool_Framework_Provider_Abstract::setRegistry()
Parameters
Name Type Description
$registry \Zend_Tool_Framework_Registry_Interface
Returns
Type Description
\Zend_Tool_Framework_Provider_Abstract
Documentation was generated by DocBlox 0.13.3.