Zend Framework  1.12
Public Member Functions | Static Protected Attributes | List of all members
Zend_Tool_Project_Profile Class Reference

Public Member Functions

 __construct ($options=null)
 Constructor, standard usage would allow the setting of options.
 
 setOptions (Array $options)
 Process options and either set a profile property or set a profile 'attribute'.
 
 getIterator ()
 getIterator() - reqruied by the RecursiveIterator interface
 
 loadFromData ()
 loadFromData() - Load a profile from data provided by the 'profilData' attribute
 
 isLoadableFromFile ()
 isLoadableFromFile() - can a profile be loaded from a file
 
 loadFromFile ()
 loadFromFile() - Load data from file
 
 storeToFile ()
 storeToFile() - store the current profile to file
 
 storeToData ()
 storeToData() - create a string representation of the profile in memory
 
 __toString ()
 __toString() - cast this profile to string to be able to view it.
 
- Public Member Functions inherited from Zend_Tool_Project_Profile_Resource_Container
 search ($matchSearchConstraints, $nonMatchSearchConstraints=null)
 Finder method to be able to find resources by context name and attributes.
 
 createResourceAt ($appendResourceOrSearchConstraints, $context, Array $attributes=array())
 createResourceAt()
 
 createResource ($context, Array $attributes=array())
 createResource()
 
 setAttributes (Array $attributes)
 setAttributes()
 
 getAttributes ()
 getAttributes()
 
 setAttribute ($name, $value)
 setAttribute()
 
 getAttribute ($name)
 getAttribute()
 
 hasAttribute ($name)
 hasAttribute()
 
 setAppendable ($appendable)
 setAppendable()
 
 isAppendable ()
 isAppendable()
 
 setParentResource (Zend_Tool_Project_Profile_Resource_Container $parentResource)
 setParentResource()
 
 getParentResource ()
 getParentResource()
 
 append (Zend_Tool_Project_Profile_Resource_Container $resource)
 append()
 
 current ()
 current() - required by RecursiveIterator
 
 key ()
 key() - required by RecursiveIterator
 
 next ()
 next() - required by RecursiveIterator
 
 rewind ()
 rewind() - required by RecursiveIterator
 
 valid ()
 valid() - - required by RecursiveIterator
 
 hasChildren ()
 hasChildren()
 
 getChildren ()
 getChildren()
 
 count ()
 count()
 
 __clone ()
 __clone()
 

Static Protected Attributes

static $_traverseEnabled = false
 

Additional Inherited Members

- Protected Attributes inherited from Zend_Tool_Project_Profile_Resource_Container
 $_subResources = array()
 
 $_position = 0
 
 $_appendable = true
 
 $_attributes = array()
 

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor, standard usage would allow the setting of options.

Parameters
array$options
Returns
bool

Member Function Documentation

__toString ( )

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

Returns
string
getIterator ( )

getIterator() - reqruied by the RecursiveIterator interface

Returns
RecursiveIteratorIterator
isLoadableFromFile ( )

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

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
bool
loadFromData ( )

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

loadFromFile ( )

loadFromFile() - Load data from file

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'

setOptions ( Array  $options)

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

Parameters
array$options
storeToData ( )

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

Returns
string
storeToFile ( )

storeToFile() - store the current profile to file

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

Member Data Documentation

$_traverseEnabled = false
staticprotected