API Documentation

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

\Zend_Tool_Project_Profile

Package: Zend\Tool

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.

Parent(s)
\Zend_Tool_Project_Profile_Resource_Container
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedbool  $_traverseEnabled= 'false'
static

Default valuefalseDetails
Type
bool

Methods

methodpublic__construct( array $options = null ) : bool

Constructor, standard usage would allow the setting of options

Parameters
Name Type Description
$options array
Returns
Type Description
bool
methodpublic__toString( ) : string

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

Returns
Type Description
string
methodpublicgetIterator( ) : \RecursiveIteratorIterator

getIterator() - reqruied by the RecursiveIterator interface

Returns
Type Description
\RecursiveIteratorIterator
methodpublicisLoadableFromFile( ) : bool

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
Type Description
bool
methodpublicloadFromData( ) : void

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

methodpublicloadFromFile( ) : void

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'

methodpublicsetOptions( array $options ) : void

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

Parameters
Name Type Description
$options array
methodpublicstoreToData( ) : string

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

Returns
Type Description
string
methodpublicstoreToFile( ) : void

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

Documentation was generated by DocBlox 0.15.1.