Tool/Project/Provider/DbTable.php

Show: inherited
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 [email protected] 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: DbTable.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Tool_Project_Provider_DbTable

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_Pretendable
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

Properties

Propertyprotectedbool $_isInitialized = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_isInitialized  
Propertyprotected\Zend_Tool_Project_Profile $_loadedProfile = null
Propertyprotected\Zend_Filter $_nameFilter = null

Default valuenullDetails
Type
\Zend_Filter
Propertyprotected$_projectPath = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Tool_Project_Provider_Abstract::$$_projectPath  
Propertyprotected$_specialties = array('FromDatabase')
Default valuearray('FromDatabase')Details
Type
n/a

Methods

methodprotected_convertTableNameToClassName( $tableName) : void

Parameters
Name Type Description
$tableName
methodprotected_findProfileDirectory( $projectDirectory = null,  $searchParentDirectories = true) : void
Parameters
Name Type Description
$projectDirectory
$searchParentDirectories
methodprotected_getContentForContext( $context,  $methodName,  $parameters) : void
Parameters
Name Type Description
$context
$methodName
$parameters
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
Name Type Description
$loadProfileFlag
Returns
Type Description
\Zend_Tool_Project_Profile
methodprotected_hasProjectProviderDirectory( $pathToProfileFile) : void
Parameters
Name Type Description
$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
Name Type Description
$contextClasses array
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
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
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
Type Description
\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( $name,  $actualTableName,  $module = null,  $forceOverwrite = false) : void

Parameters
Name Type Description
$name
$actualTableName
$module
$forceOverwrite
methodpubliccreateFromDatabase(string $module = null, bool $forceOverwrite = false) : void

Parameters
Name Type Description
$module string

Module name action should be applied to.

$forceOverwrite bool

Whether should force overwriting previous classes generated

methodpubliccreateResource( $profile,  $dbTableName,  $actualTableName,  $moduleName = null) : void
static

Parameters
Name Type Description
$profile
$dbTableName
$actualTableName
$moduleName
methodpublicgetContextClasses() : void
methodpublichasResource( $profile,  $dbTableName,  $moduleName = null) : void
static

Parameters
Name Type Description
$profile
$dbTableName
$moduleName
methodpublicinitialize() : void
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
Name Type Description
$registry \Zend_Tool_Framework_Registry_Interface
Returns
Type Description
\Zend_Tool_Framework_Provider_Abstract
Documentation was generated by phpDocumentor 2.0.0a8.