This class is the front most class for utilizing Zend_Tool_Project

A profile is a hierarchical set of resources that keep track of items within a specific project.

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

 Methods

__clone()

__clone() 
Inherited

Constructor, standard usage would allow the setting of options

__construct(array $options = null) : boolean

Parameters

$options

array

Returns

boolean

__toString() - cast this profile to string to be able to view it.

__toString() : string

Returns

string

append()

append(\Zend_Tool_Project_Profile_Resource_Container $resource) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Parameters

$resource

\Zend_Tool_Project_Profile_Resource_Container

Returns

\Zend_Tool_Project_Profile_Resource_Container

count()

count() : integer
Inherited

Returns

integer

createResource()

createResource(string $context, array $attributes = array()) : \Zend_Tool_Project_Profile_Resource
Inherited

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

Parameters

$context

string

$attributes

array

Returns

\Zend_Tool_Project_Profile_Resource

createResourceAt()

createResourceAt(array|\Zend_Tool_Project_Profile_Resource_SearchConstraints $appendResourceOrSearchConstraints, string $context, array $attributes = array()) : \Zend_Tool_Project_Profile_Resource
Inherited

Parameters

$appendResourceOrSearchConstraints

array\Zend_Tool_Project_Profile_Resource_SearchConstraints

$context

string

$attributes

array

Returns

\Zend_Tool_Project_Profile_Resource

current() - required by RecursiveIterator

current() : \Zend_Tool_Project_Profile_Resource
Inherited

Returns

\Zend_Tool_Project_Profile_Resource

getAttribute()

getAttribute(string $name) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Parameters

$name

string

Returns

\Zend_Tool_Project_Profile_Resource_Container

getAttributes()

getAttributes() : array
Inherited

Returns

array

getChildren()

getChildren() : array
Inherited

Returns

array

getIterator() - reqruied by the RecursiveIterator interface

getIterator() : \RecursiveIteratorIterator

Returns

\RecursiveIteratorIterator

getParentResource()

getParentResource() : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Returns

\Zend_Tool_Project_Profile_Resource_Container

hasAttribute()

hasAttribute(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

hasChildren()

hasChildren() : boolean
Inherited

Returns

boolean

isAppendable()

isAppendable() : boolean
Inherited

Returns

boolean

isLoadableFromFile() - can a profile be loaded from a file

isLoadableFromFile() : boolean

wether or not a profile can be loaded from the file in attribute 'projectProfileFile', or from a file named '.zfproject.xml' inside a directory in key 'projectDirectory'

Returns

boolean

key() - required by RecursiveIterator

key() : integer
Inherited

Returns

integer

loadFromData() - Load a profile from data provided by the 'profilData' attribute

loadFromData() 

loadFromFile() - Load data from file

loadFromFile() 

this attempts to load a project profile file from a variety of locations depending on what information the user provided vie $options or attributes, specifically the 'projectDirectory' or 'projectProfileFile'

next() - required by RecursiveIterator

next() : boolean
Inherited

Returns

boolean

rewind() - required by RecursiveIterator

rewind() : boolean
Inherited

Returns

boolean

setAppendable()

setAppendable(boolean $appendable) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Parameters

$appendable

boolean

Returns

\Zend_Tool_Project_Profile_Resource_Container

setAttribute()

setAttribute(string $name, mixed $value) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Parameters

$name

string

$value

mixed

Returns

\Zend_Tool_Project_Profile_Resource_Container

setAttributes()

setAttributes(array $attributes) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

persist the attributes if the resource will accept them

Parameters

$attributes

array

Returns

\Zend_Tool_Project_Profile_Resource_Container

Process options and either set a profile property or set a profile 'attribute'

setOptions(array $options) 

Parameters

$options

array

setParentResource()

setParentResource(\Zend_Tool_Project_Profile_Resource_Container $parentResource) : \Zend_Tool_Project_Profile_Resource_Container
Inherited

Parameters

$parentResource

\Zend_Tool_Project_Profile_Resource_Container

Returns

\Zend_Tool_Project_Profile_Resource_Container

storeToData() - create a string representation of the profile in memory

storeToData() : string

Returns

string

storeToFile() - store the current profile to file

storeToFile() 

This will store the profile in memory to a place on disk determined by the attributes available, specifically if the key 'projectProfileFile' is available

valid() - - required by RecursiveIterator

valid() : boolean
Inherited

Returns

boolean

 Properties

 

$_appendable

$_appendable : boolean

Default

true
 

$_attributes

$_attributes : array

Default

array()
 

$_position

$_position : integer

Default

0
 

$_subResources

$_subResources : array

Default

array()
 

$_traverseEnabled

$_traverseEnabled : boolean

Default

false
Static