Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Zend_Tool_Project_Provider_Abstract Class Reference

Public Member Functions

 initialize ()
 
 getContextClasses ()
 
- Public Member Functions inherited from Zend_Tool_Framework_Provider_Abstract
 setRegistry (Zend_Tool_Framework_Registry_Interface $registry)
 setRegistry() - required by Zend_Tool_Framework_Registry_EnabledInterface
 

Public Attributes

const NO_PROFILE_THROW_EXCEPTION = true
 
const NO_PROFILE_RETURN_FALSE = false
 

Protected Member Functions

 _loadProfile ($loadProfileFlag=self::NO_PROFILE_THROW_EXCEPTION, $projectDirectory=null, $searchParentDirectories=true)
 _getProject is designed to find if there is project file in the context of where the client has been called from.
 
 _findProfileDirectory ($projectDirectory=null, $searchParentDirectories=true)
 
 _loadProfileRequired ()
 Load the project profile from the current working directory, if not throw exception.
 
 _getProfile ($loadProfileFlag=self::NO_PROFILE_THROW_EXCEPTION)
 Return the currently loaded profile.
 
 _storeProfile ()
 _storeProfile()
 
 _getContentForContext (Zend_Tool_Project_Context_Interface $context, $methodName, $parameters)
 
 _hasProjectProviderDirectory ($pathToProfileFile)
 

Protected Attributes

 $_projectPath = null
 
 $_loadedProfile = null
 
- Protected Attributes inherited from Zend_Tool_Framework_Provider_Abstract
 $_registry = null
 

Static Protected Attributes

static $_isInitialized = false
 

Member Function Documentation

_findProfileDirectory (   $projectDirectory = null,
  $searchParentDirectories = true 
)
protected
_getContentForContext ( Zend_Tool_Project_Context_Interface  $context,
  $methodName,
  $parameters 
)
protected
_getProfile (   $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION)
protected

Return the currently loaded profile.

Returns
Zend_Tool_Project_Profile
_hasProjectProviderDirectory (   $pathToProfileFile)
protected
_loadProfile (   $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION,
  $projectDirectory = null,
  $searchParentDirectories = true 
)
protected

_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..

  • 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
bool$loadProfileFlagWhether or not to throw an exception when no profile is found
string$projectDirectoryThe project directory to use to search
bool$searchParentDirectoriesWhether or not to search upper level direcotries
Returns
Zend_Tool_Project_Profile
_loadProfileRequired ( )
protected

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

Returns
Zend_Tool_Project_Profile
_storeProfile ( )
protected

_storeProfile()

This method will store the profile into its proper location

getContextClasses ( )
initialize ( )

Member Data Documentation

$_isInitialized = false
staticprotected
$_loadedProfile = null
protected
$_projectPath = null
protected
const NO_PROFILE_RETURN_FALSE = false
const NO_PROFILE_THROW_EXCEPTION = true