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

category Zend
package Zend_Tool
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Tool_Project_Provider_Abstract

 Methods

create()

create($name, $actualTableName, $module = null, $forceOverwrite = false

Parameters

$name

$actualTableName

$module

$forceOverwrite

createFromDatabase()

createFromDatabase(string $module = null, boolean $forceOverwrite = false) : void

Parameters

$module

string

Module name action should be applied to.

$forceOverwrite

boolean

Whether should force overwriting previous classes generated

createResource()

createResource(\Zend_Tool_Project_Profile $profile, $dbTableName, $actualTableName, $moduleName = null
Static

Parameters

$profile

$dbTableName

$actualTableName

$moduleName

getContextClasses()

getContextClasses() 
Inherited

hasResource()

hasResource(\Zend_Tool_Project_Profile $profile, $dbTableName, $moduleName = null
Static

Parameters

$profile

$dbTableName

$moduleName

initialize()

initialize() 
Inherited
inherited_from \Zend_Tool_Framework_Provider_Initializable::initialize()

setRegistry() - required by Zend_Tool_Framework_Registry_EnabledInterface

setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Provider_Abstract
Inherited
inherited_from \Zend_Tool_Framework_Registry_EnabledInterface::setRegistry()

Parameters

$registry

\Zend_Tool_Framework_Registry_Interface

Returns

\Zend_Tool_Framework_Provider_Abstract

_convertTableNameToClassName()

_convertTableNameToClassName($tableName) 

Parameters

$tableName

_findProfileDirectory()

_findProfileDirectory($projectDirectory = null, $searchParentDirectories = true
Inherited

Parameters

$projectDirectory

$searchParentDirectories

_getContentForContext()

_getContentForContext(\Zend_Tool_Project_Context_Interface $context, $methodName, $parameters) 
Inherited

Parameters

$context

$methodName

$parameters

Return the currently loaded profile

_getProfile($loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION) : \Zend_Tool_Project_Profile
Inherited

Parameters

$loadProfileFlag

Returns

\Zend_Tool_Project_Profile

_hasProjectProviderDirectory()

_hasProjectProviderDirectory($pathToProfileFile) 
Inherited

Parameters

$pathToProfileFile

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

_loadProfile(boolean $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION, string $projectDirectory = null, boolean $searchParentDirectories = true) : \Zend_Tool_Project_Profile
Inherited

. The search order is as follows..

  • 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

$loadProfileFlag

boolean

Whether or not to throw an exception when no profile is found

$projectDirectory

string

The project directory to use to search

$searchParentDirectories

boolean

Whether or not to search upper level direcotries

Returns

\Zend_Tool_Project_Profile

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

_loadProfileRequired() : \Zend_Tool_Project_Profile
Inherited

Returns

\Zend_Tool_Project_Profile

_storeProfile()

_storeProfile() 
Inherited

This method will store the profile into its proper location

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

_loadContextClassesIntoRegistry(array $contextClasses) 
Inherited

Parameters

$contextClasses

array

 Properties

 

$_isInitialized

$_isInitialized : boolean

Default

false
Static
 

$_loadedProfile

$_loadedProfile : \Zend_Tool_Project_Profile

Default

null
 

$_nameFilter

$_nameFilter : \Zend_Filter

Default

null
 

$_projectPath

$_projectPath 

Default

null
 

$_registry

$_registry : \Zend_Tool_Framework_Registry_Interface

Default

null
 

$_specialties

$_specialties 

Default

array('FromDatabase')

 Constants

 

NO_PROFILE_RETURN_FALSE

NO_PROFILE_RETURN_FALSE = false 
 

NO_PROFILE_THROW_EXCEPTION

NO_PROFILE_THROW_EXCEPTION = true