API Documentation

Zend/Tool/Project/Profile/Resource/Container.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 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: Container.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Project_Profile_Resource_Container

Package: Zend\Tool

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

Implements
Children
\Zend_Tool_Project_Profile_Resource
\Zend_Tool_Project_Profile
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedbool  $_appendable= 'true'

Default valuetrueDetails
Type
bool
Propertyprotectedarray  $_attributes= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedint  $_position= '0'

Default value0Details
Type
int
Propertyprotectedarray  $_subResources= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublic__clone( ) : void

__clone()

methodpubliccount( ) : int

count()

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

createResource()

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

createResourceAt()

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

Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicgetAttribute( string $name ) : \Zend_Tool_Project_Profile_Resource_Container

getAttribute()

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicgetAttributes( ) : array

getAttributes()

Returns
Type Description
array
methodpublicgetChildren( ) : array

getChildren()

Returns
Type Description
array
methodpublicgetParentResource( ) : \Zend_Tool_Project_Profile_Resource_Container

getParentResource()

methodpublichasAttribute( string $name ) : bool

hasAttribute()

Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublichasChildren( ) : bool

hasChildren()

Returns
Type Description
bool
methodpublicisAppendable( ) : bool

isAppendable()

Returns
Type Description
bool
methodpublickey( ) : int

key() - required by RecursiveIterator

Returns
Type Description
int
methodpublicnext( ) : bool

next() - required by RecursiveIterator

Returns
Type Description
bool
methodpublicrewind( ) : bool

rewind() - required by RecursiveIterator

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:


Parameters
Name Type Description
$matchSearchConstraints
$nonMatchSearchConstraints
Returns
Type Description
\Zend_Tool_Project_Profile_Resource
methodpublicsetAppendable( bool $appendable ) : \Zend_Tool_Project_Profile_Resource_Container

setAppendable()

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

setAttribute()

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

setAttributes()

persist the attributes if the resource will accept them

Parameters
Name Type Description
$attributes array
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetParentResource( \Zend_Tool_Project_Profile_Resource_Container $parentResource ) : \Zend_Tool_Project_Profile_Resource_Container

setParentResource()

Parameters
Name Type Description
$parentResource \Zend_Tool_Project_Profile_Resource_Container
Returns
Type Description
\Zend_Tool_Project_Profile_Resource_Container
methodpublicvalid( ) : bool

valid() - - required by RecursiveIterator

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.