API Documentation

Tool/Project/Profile/Resource.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tool  
subpackage
Framework  
version
$Id: Resource.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Tool_Project_Profile_Resource

This class is an iterator that will iterate only over enabled resources

Extends from
\Zend_Tool_Project_Profile_Resource_Container
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tool  

Properties

Propertyprotectedarray  $_attributes= 'array'

Default valuearrayDetails
Type
array
Propertyprotected\Zend_Tool_Project_Context|string  $_context= 'null'

Default valuenullDetails
Type
\Zend_Tool_Project_Contextstring
Propertyprotected  $_deleted= 'false'
Default valuefalseDetails
Type
Propertyprotected  $_enabled= 'true'
Default valuetrueDetails
Type
Propertyprotectedbool  $_isContextInitialized= 'false'

Default valuefalseDetails
Type
bool
Propertyprotected\Zend_Tool_Project_Profile_Resource  $_parentResource= 'null'

Default valuenullDetails
Type
\Zend_Tool_Project_Profile_Resource
Propertyprotected\Zend_Tool_Project_Profile  $_profile= 'null'

Default valuenullDetails
Type
\Zend_Tool_Project_Profile

Methods

methodpublic__call( string $method, array $arguments ) : \Zend_Tool_Project_Profile_Resource

__call()

Parameters
Name Type Description
$method string
$arguments array
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublic__clone( ) : void
methodpublic__construct( string|\Zend_Tool_Project_Context_Interface $context ) : void

__construct()

Parameters
Name Type Description
$context string|\Zend_Tool_Project_Context_Interface
methodpublic__toString( ) : string

__toString()

Returns
Type Description
string
methodpubliccount( ) : int
Returns
Type Description
int
methodpubliccreateResource( string $context, array $attributes = array ) : \Zend_Tool_Project_Profile_Resource

Method to create a resource with a given context with specific attributes

Parameters
Name Type Description
$context string
$attributes array
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpubliccreateResourceAt( array|\Zend_Tool_Project_Profile_Resource_SearchConstraints $appendResourceOrSearchConstraints, string $context, array $attributes = array ) : \Zend_Tool_Project_Profile_Resource
Parameters
Name Type Description
$appendResourceOrSearchConstraints array|\Zend_Tool_Project_Profile_Resource_SearchConstraints
$context string
$attributes array
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpubliccurrent( ) : \Zend_Tool_Project_Profile_Resource

current() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::current()
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicgetAttribute( string $name ) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicgetAttributes( ) : array
Returns
Type Description
array
methodpublicgetChildren( ) : array
Returns
Type Description
array
methodpublicgetContext( ) : \Zend_Tool_Project_Context_Interface

getContext()

Returns
Type Description
\Zend_Tool_Project_Context_Interface
methodpublicgetName( ) : string

getName() - Get the resource name

Name is derived from the context name

Returns
Type Description
string
methodpublicgetPersistentAttributes( ) : array

getPersistentAttributes()

Returns
Type Description
array
methodpublicgetProfile( ) : \Zend_Tool_Project_Profile

getProfile

Returns
Type Description
\Zend_Tool_Project_Profile
methodpublichasAttribute( string $name ) : bool
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublichasChildren( ) : bool
Returns
Type Description
bool
methodpublicinitializeContext( ) : \Zend_Tool_Project_Profile_Resource

initializeContext()

Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicisAppendable( ) : bool
Returns
Type Description
bool
methodpublicisDeleted( ) : \Zend_Tool_Project_Profile_Resource

isDeleted()

Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicisEnabled( ) : bool

isEnabled()

Returns
Type Description
bool
methodpublickey( ) : int

key() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::key()
Returns
Type Description
int
methodpublicnext( ) : bool

next() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::next()
Returns
Type Description
bool
methodpublicrewind( ) : bool

rewind() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::rewind()
Returns
Type Description
bool
methodpublicsearch(  $matchSearchConstraints,  $nonMatchSearchConstraints = null ) : \Zend_Tool_Project_Profile_Resource

Finder method to be able to find resources by context name and attributes. Example usage:

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::search()

Parameters
Name Type Description
$matchSearchConstraints
$nonMatchSearchConstraints
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicsetAppendable( bool $appendable ) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
Name Type Description
$appendable bool
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetAttribute( string $name, mixed $value ) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetAttributes( array $attributes ) : \Zend_Tool_Project_Profile_Resource_Container

persist the attributes if the resource will accept them

Parameters
Name Type Description
$attributes array
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetContext( string|\Zend_Tool_Project_Context_Interface $context ) : \Zend_Tool_Project_Profile_Resource

setContext()

Parameters
Name Type Description
$context string|\Zend_Tool_Project_Context_Interface
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicsetDeleted( bool $deleted = true ) : \Zend_Tool_Project_Profile_Resource

setDeleted()

Parameters
Name Type Description
$deleted bool
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicsetEnabled( bool $enabled = true ) : \Zend_Tool_Project_Profile_Resource

setEnabled()

Parameters
Name Type Description
$enabled bool
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicsetProfile( \Zend_Tool_Project_Profile $profile ) : \Zend_Tool_Project_Profile_Resource

setProfile()

Parameters
Name Type Description
$profile \Zend_Tool_Project_Profile
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicvalid( ) : bool

valid() - - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::valid()
Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.