Tool/Project/Provider/Abstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Tool
subpackage: Framework
version: $Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Tool_Project_Provider_Abstract

Description

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.

Zend_Tool_Project_Provider_Abstract
jump to top

Extends from: Zend_Tool_Framework_Provider_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Tool
Constants: NO_PROFILE_THROW_EXCEPTION; NO_PROFILE_RETURN_FALSE
Properties: $_isInitialized; $_projectPath; $_loadedProfile
Methods: __construct; getContextClasses; _loadProfile; _loadProfileRequired; _getProfile; _storeProfile; _getContentForContext; _loadContextClassesIntoRegistry

Description

Constants

NO_PROFILE_THROW_EXCEPTION
jump to class

 NO_PROFILE_THROW_EXCEPTION = 'true'

Details

value: true

NO_PROFILE_RETURN_FALSE
jump to class

 NO_PROFILE_RETURN_FALSE = 'false'

Details

value: false

Properties

$_isInitialized
jump to class

bool $_isInitialized = 'false'

Details

$_isInitialized: bool
visibility: protected
default: false
final: false
static: true

$_loadedProfile
jump to class

Zend_Tool_Project_Profile $_loadedProfile = 'null'

Details

$_loadedProfile: Zend_Tool_Project_Profile
visibility: protected
default: null
final: false
static: false

$_projectPath
jump to class

$_projectPath = 'null'

Details

visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

constructor

YOU SHOULD NOT OVERRIDE THIS, unless you know what you are doing

Details

visibility: public
final: false
static: false

_getContentForContext
jump to class

_getContentForContext(
           $context,  $methodName,  $parameters
          )
        
        :

Arguments

$context
$methodName
$parameters

Details

visibility: protected
final: false
static: false

_getProfile
jump to class

_getProfile(
           $loadProfileFlag
              =
              self
          )
        
        :
        Zend_Tool_Project_Profile

Return the currently loaded profile

Arguments

$loadProfileFlag

Output

Zend_Tool_Project_Profile

Details

visibility: protected
final: false
static: false

_loadContextClassesIntoRegistry
jump to class

_loadContextClassesIntoRegistry(
          array $contextClasses
          )
        
        :

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

Arguments

$contextClasses: array

Details

visibility: private
final: false
static: false

_loadProfile
jump to class

_loadProfile(
          $loadProfileFlag $loadProfileFlag
              =
              self, $projectDirectory $projectDirectory
              =
              null, $searchParentDirectories $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..

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

Arguments

$loadProfileFlag: $loadProfileFlag
bool Whether or not to throw an exception when no profile is found
$projectDirectory: $projectDirectory
string The project directory to use to search
$searchParentDirectories: $searchParentDirectories
bool Whether or not to search upper level direcotries

Output

Zend_Tool_Project_Profile

Details

visibility: protected
final: false
static: false

_loadProfileRequired
jump to class

_loadProfileRequired(
          
          )
        
        :
        Zend_Tool_Project_Profile

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

Output

Zend_Tool_Project_Profile

Details

visibility: protected
final: false
static: false

_storeProfile
jump to class

_storeProfile(
          
          )
        
        :

_storeProfile()

This method will store the profile into its proper location

Details

visibility: protected
final: false
static: false

getContextClasses
jump to class

getContextClasses(
          
          )
        
        :

Details

visibility: public
final: false
static: false

API Documentation

Tool/Project/Provider/Abstract.php

Description

Zend_Tool_Project_Provider_Abstractjump to top

Description

Constants

NO_PROFILE_THROW_EXCEPTIONjump to class

Details

NO_PROFILE_RETURN_FALSEjump to class

Details

Properties

$_isInitializedjump to class

Details

$_loadedProfilejump to class

Details

$_projectPathjump to class

Details

Methods

__constructjump to class

Details

_getContentForContextjump to class

Arguments

Details

_getProfilejump to class

Arguments

Output

Details

_loadContextClassesIntoRegistryjump to class

Arguments

Details

_loadProfilejump to class

Arguments

Output

Details

_loadProfileRequiredjump to class

Output

Details

_storeProfilejump to class

Details

getContextClassesjump to class

Details

Zend_Tool_Project_Provider_Abstract
jump to top

NO_PROFILE_THROW_EXCEPTION
jump to class

NO_PROFILE_RETURN_FALSE
jump to class

$_isInitialized
jump to class

$_loadedProfile
jump to class

$_projectPath
jump to class

__construct
jump to class

_getContentForContext
jump to class

_getProfile
jump to class

_loadContextClassesIntoRegistry
jump to class

_loadProfile
jump to class

_loadProfileRequired
jump to class

_storeProfile
jump to class

getContextClasses
jump to class