Tool/Project/Provider/Model.php

Show: PublicProtectedPrivateinherited
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: Model.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Tool_Project_Provider_Model
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

Parent(s)
\Zend_Tool_Project_Provider_Abstract < \Zend_Tool_Framework_Provider_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  NO_PROFILE_THROW_EXCEPTION = true
inheritedInherited from: \Zend_Tool_Project_Provider_Abstract::NO_PROFILE_THROW_EXCEPTION
Inherited_from
\Zend_Tool_Project_Provider_Abstract::NO_PROFILE_THROW_EXCEPTION  
>VConstant  NO_PROFILE_RETURN_FALSE = false
inheritedInherited from: \Zend_Tool_Project_Provider_Abstract::NO_PROFILE_RETURN_FALSE
Inherited_from
\Zend_Tool_Project_Provider_Abstract::NO_PROFILE_RETURN_FALSE  

Properties

>VPropertyprotectedbool $_isInitialized = false
staticinherited
Inherited from: \Zend_Tool_Project_Provider_Abstract::$$_isInitialized
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_isInitialized  
>VPropertyprotected\Zend_Tool_Project_Profile $_loadedProfile = null
inherited
Inherited from: \Zend_Tool_Project_Provider_Abstract::$$_loadedProfile
Default valuenullDetails
Type
\Zend_Tool_Project_Profile
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_loadedProfile  
>VPropertyprotected$_projectPath = null
inheritedInherited from: \Zend_Tool_Project_Provider_Abstract::$$_projectPath
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_projectPath  
>VPropertyprotected\Zend_Tool_Framework_Registry_Interface $_registry = null
inherited
Inherited from: \Zend_Tool_Framework_Provider_Abstract::$$_registry\Zend_Tool_Project_Provider_Abstract::$$_registry
Default valuenullDetails
Type
\Zend_Tool_Framework_Registry_Interface
Inherited_from
\Zend_Tool_Framework_Provider_Abstract::$$_registry  
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_registry  

Methods

methodprotected_findProfileDirectory( $projectDirectory = null,  $searchParentDirectories = true) : void
inherited

Inherited from: \Zend_Tool_Project_Provider_Abstract::_findProfileDirectory()
Parameters
NameTypeDescription
$projectDirectory
$searchParentDirectories
methodprotected_getContentForContext( $context,  $methodName,  $parameters) : void
inherited

Inherited from: \Zend_Tool_Project_Provider_Abstract::_getContentForContext()
Parameters
NameTypeDescription
$context
$methodName
$parameters
methodprotected_getModelsDirectoryResource(\Zend_Tool_Project_Profile $profile, string $moduleName = null) : \Zend_Tool_Project_Profile_Resource
static

_getModelsDirectoryResource()

Parameters
NameTypeDescription
$profile\Zend_Tool_Project_Profile
$moduleNamestring
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodprotected_getProfile( $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION) : \Zend_Tool_Project_Profile
inherited

Return the currently loaded profile

Inherited from: \Zend_Tool_Project_Provider_Abstract::_getProfile()
Parameters
NameTypeDescription
$loadProfileFlag
Returns
TypeDescription
\Zend_Tool_Project_Profile
methodprotected_hasProjectProviderDirectory( $pathToProfileFile) : void
inherited

Inherited from: \Zend_Tool_Project_Provider_Abstract::_hasProjectProviderDirectory()
Parameters
NameTypeDescription
$pathToProfileFile
methodprivate_loadContextClassesIntoRegistry(array $contextClasses) : void
inherited

_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
NameTypeDescription
$contextClassesarray
methodprotected_loadProfile(bool $loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION, string $projectDirectory = null, bool $searchParentDirectories = true) : \Zend_Tool_Project_Profile
inherited

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

Inherited from: \Zend_Tool_Project_Provider_Abstract::_loadProfile()

. 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
NameTypeDescription
$loadProfileFlagbool

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

$projectDirectorystring

The project directory to use to search

$searchParentDirectoriesbool

Whether or not to search upper level direcotries

Returns
TypeDescription
\Zend_Tool_Project_Profile
methodprotected_loadProfileRequired() : \Zend_Tool_Project_Profile
inherited

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

Inherited from: \Zend_Tool_Project_Provider_Abstract::_loadProfileRequired()
Returns
TypeDescription
\Zend_Tool_Project_Profile
methodprotected_storeProfile() : void
inherited

_storeProfile()

Inherited from: \Zend_Tool_Project_Provider_Abstract::_storeProfile()

This method will store the profile into its proper location

methodpubliccreate(string $name, string $module = null) : void

Create a new model

Parameters
NameTypeDescription
$namestring
$modulestring
methodpubliccreateResource( $profile,  $modelName,  $moduleName = null) : void
static

Parameters
NameTypeDescription
$profile
$modelName
$moduleName
methodpublicgetContextClasses() : void
inherited

Inherited from: \Zend_Tool_Project_Provider_Abstract::getContextClasses()
methodpublichasResource(\Zend_Tool_Project_Profile $profile, string $modelName, string $moduleName = null) : \Zend_Tool_Project_Profile_Resource
static

hasResource()

Parameters
NameTypeDescription
$profile\Zend_Tool_Project_Profile
$modelNamestring
$moduleNamestring
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicinitialize() : void
inherited

Inherited from: \Zend_Tool_Project_Provider_Abstract::initialize()
methodpublicsetRegistry(\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()\Zend_Tool_Project_Provider_Abstract::setRegistry()
Parameters
NameTypeDescription
$registry\Zend_Tool_Framework_Registry_Interface
Returns
TypeDescription
\Zend_Tool_Framework_Provider_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.