Tool/Project/Provider/Abstract.php

Show:

inherited

Classes
- \Zend_Tool_Project_Provider_Abstract

Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Tool
Subpackage: Framework
Version: $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Tool_Project_Provider_Abstract
jump to top

Package: Zend\Tool

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

Implements: \Zend_Tool_Framework_Provider_Initializable
Parent(s): \Zend_Tool_Framework_Provider_Abstract
Children: \Zend_Tool_Project_Provider_Application; \Zend_Tool_Project_Provider_Controller; \Zend_Tool_Project_Provider_Layout; \Zend_Tool_Project_Provider_Form; \Zend_Tool_Project_Provider_Action; \Zend_Tool_Project_Provider_Project; \Zend_Tool_Project_Provider_Test; \Zend_Tool_Project_Provider_DbTable; \Zend_Tool_Project_Provider_View; \Zend_Tool_Project_Provider_Module; \Zend_Tool_Project_Provider_Model; \Zend_Tool_Project_Provider_ProjectProvider; \Zend_Tool_Project_Provider_Profile; \Zend_Tool_Project_Provider_DbAdapter
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                NO_PROFILE_THROW_EXCEPTION
                = true

 
                NO_PROFILE_RETURN_FALSE
                = false

Properties

bool $_isInitialized = false

static

Default valuefalseDetails

Type: bool

\Zend_Tool_Project_Profile $_loadedProfile = null

Default valuenullDetails

Type: \Zend_Tool_Project_Profile

$_projectPath = null

Default valuenullDetails

Type: n/a

\Zend_Tool_Framework_Registry_Interface $_registry = null

inherited

Inherited from: \Zend_Tool_Framework_Provider_Abstract::$$_registry

Default valuenullDetails

Type: \Zend_Tool_Framework_Registry_Interface
Inherited_from: \Zend_Tool_Framework_Provider_Abstract::$$_registry

Methods

_findProfileDirectory( $projectDirectory = null, $searchParentDirectories = true) : void

Parameters

Name	Type	Description
$projectDirectory
$searchParentDirectories

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

Parameters

Name	Type	Description
$context
$methodName
$parameters

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

Return the currently loaded profile

Parameters

Name	Type	Description
$loadProfileFlag

Returns

Type	Description
\Zend_Tool_Project_Profile

_hasProjectProviderDirectory( $pathToProfileFile) : void

Parameters

Name	Type	Description
$pathToProfileFile

_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

Parameters

Name	Type	Description
$contextClasses	array

_loadProfile(bool $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION, 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.. - 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

_loadProfileRequired() : \Zend_Tool_Project_Profile

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

Returns

Type	Description
\Zend_Tool_Project_Profile

_storeProfile() : void

_storeProfile()

This method will store the profile into its proper location

getContextClasses() : void

initialize() : void

setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Provider_Abstract

inherited

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

Tool/Project/Provider/Abstract.php

\Zend_Tool_Project_Provider_Abstractjump to top

Constants

Properties

Methods

\Zend_Tool_Project_Provider_Abstract
jump to top