API Documentation

Tool/Project/Profile.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
subpackage
Framework
version
$Id: Profile.php 20967 2010-02-07 18:17:49Z ralph $
Classes
Zend_Tool_Project_Profile

Description

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.

Zend_Tool_Project_Profile
jump to top

Extends from
Zend_Tool_Project_Profile_Resource_Container
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
Properties
$_traverseEnabled
Methods
__construct
setOptions
getIterator
loadFromData
isLoadableFromFile
loadFromFile
storeToFile
storeToData
__toString

Description

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.

Properties

$_traverseEnabled
jump to class

bool $_traverseEnabled = 'false'

Details

$_traverseEnabled
bool
visibility
protected
default
false
final
false
static
true

Methods

__construct
jump to class

__construct( array $options = null ) : bool

Constructor, standard usage would allow the setting of options

Arguments
$options
array
Output
bool
Details
visibility
public
final
false
static
false

__toString
jump to class

__toString( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

getIterator
jump to class

getIterator( ) : RecursiveIteratorIterator

getIterator() - reqruied by the RecursiveIterator interface

Output
RecursiveIteratorIterator
Details
visibility
public
final
false
static
false

isLoadableFromFile
jump to class

isLoadableFromFile( ) : 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'

Output
bool
Details
visibility
public
final
false
static
false

loadFromData
jump to class

loadFromData( ) :

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

Details
visibility
public
final
false
static
false

loadFromFile
jump to class

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'

Details
visibility
public
final
false
static
false

setOptions
jump to class

setOptions( array $options ) :

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

Arguments
$options
array
Details
visibility
public
final
false
static
false

storeToData
jump to class

storeToData( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

storeToFile
jump to class

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

Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.