Tool/Project/Profile/Resource.php

Show: PublicProtectedPrivateinherited
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: Resource.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Tool_Project_Profile_Resource

Package: Zend\Tool
This class is an iterator that will iterate only over enabled resources
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

>VPropertyprotectedbool $_appendable = true
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_Tool_Project_Profile_Resource_Container::$$_appendable  
>VPropertyprotectedarray $_attributes = array()
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Tool_Project_Context|string $_context = null
Default valuenullDetails
Type
\Zend_Tool_Project_Context | string
>VPropertyprotected$_deleted = false
Default valuefalseDetails
Type
n/a
>VPropertyprotected$_enabled = true
Default valuetrueDetails
Type
n/a
>VPropertyprotectedbool $_isContextInitialized = false
Default valuefalseDetails
Type
bool
>VPropertyprotected\Zend_Tool_Project_Profile_Resource $_parentResource = null
Default valuenullDetails
Type
\Zend_Tool_Project_Profile_Resource
>VPropertyprotectedint $_position = 0
Default value0Details
Type
int
Inherited_from
\Zend_Tool_Project_Profile_Resource_Container::$$_position  
>VPropertyprotected\Zend_Tool_Project_Profile $_profile = null
Default valuenullDetails
Type
\Zend_Tool_Project_Profile
>VPropertyprotectedarray $_subResources = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Tool_Project_Profile_Resource_Container::$$_subResources  

Methods

methodpublic__call(string $method, array $arguments) : \Zend_Tool_Project_Profile_Resource

__call()

Parameters
NameTypeDescription
$methodstring
$argumentsarray
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublic__clone() : void
methodpublic__construct(string | \Zend_Tool_Project_Context_Interface $context) : void

__construct()

Parameters
NameTypeDescription
$contextstring | \Zend_Tool_Project_Context_Interface
methodpublic__toString() : string

__toString()

Returns
TypeDescription
string
methodpubliccount() : int
Returns
TypeDescription
int
methodpubliccreateResource(string $context, array $attributes = array()) : \Zend_Tool_Project_Profile_Resource

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

Parameters
NameTypeDescription
$contextstring
$attributesarray
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpubliccreateResourceAt(array | \Zend_Tool_Project_Profile_Resource_SearchConstraints $appendResourceOrSearchConstraints, string $context, array $attributes = array()) : \Zend_Tool_Project_Profile_Resource
Parameters
NameTypeDescription
$appendResourceOrSearchConstraintsarray | \Zend_Tool_Project_Profile_Resource_SearchConstraints
$contextstring
$attributesarray
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpubliccurrent() : \Zend_Tool_Project_Profile_Resource
inherited

current() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::current()
methodpublicgetAttribute(string $name) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource_Container
methodpublicgetAttributes() : array
Returns
TypeDescription
array
methodpublicgetChildren() : array
Returns
TypeDescription
array
methodpublicgetContext() : \Zend_Tool_Project_Context_Interface

getContext()

methodpublicgetName() : string

getName() - Get the resource name

Name is derived from the context name

Returns
TypeDescription
string
methodpublicgetPersistentAttributes() : array

getPersistentAttributes()

Returns
TypeDescription
array
methodpublicgetProfile() : \Zend_Tool_Project_Profile

getProfile

Returns
TypeDescription
\Zend_Tool_Project_Profile
methodpublichasAttribute(string $name) : bool
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
bool
methodpublichasChildren() : bool
Returns
TypeDescription
bool
methodpublicinitializeContext() : \Zend_Tool_Project_Profile_Resource

initializeContext()

methodpublicisAppendable() : bool
Returns
TypeDescription
bool
methodpublicisDeleted() : \Zend_Tool_Project_Profile_Resource

isDeleted()

methodpublicisEnabled() : bool

isEnabled()

Returns
TypeDescription
bool
methodpublickey() : int
inherited

key() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::key()
Returns
TypeDescription
int
methodpublicnext() : bool
inherited

next() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::next()
Returns
TypeDescription
bool
methodpublicrewind() : bool
inherited

rewind() - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::rewind()
Returns
TypeDescription
bool
methodpublicsearch( $matchSearchConstraints,  $nonMatchSearchConstraints = null) : \Zend_Tool_Project_Profile_Resource
inherited

Finder method to be able to find resources by context name and attributes.

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::search()

Example usage:


Parameters
NameTypeDescription
$matchSearchConstraints
$nonMatchSearchConstraints
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicsetAppendable(bool $appendable) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
NameTypeDescription
$appendablebool
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetAttribute(string $name, mixed $value) : \Zend_Tool_Project_Profile_Resource_Container
Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetAttributes(array $attributes) : \Zend_Tool_Project_Profile_Resource_Container

persist the attributes if the resource will accept them

Parameters
NameTypeDescription
$attributesarray
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource_Container
methodpublicsetContext(string | \Zend_Tool_Project_Context_Interface $context) : \Zend_Tool_Project_Profile_Resource

setContext()

Parameters
NameTypeDescription
$contextstring | \Zend_Tool_Project_Context_Interface
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicsetDeleted(bool $deleted = true) : \Zend_Tool_Project_Profile_Resource

setDeleted()

Parameters
NameTypeDescription
$deletedbool
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicsetEnabled(bool $enabled = true) : \Zend_Tool_Project_Profile_Resource

setEnabled()

Parameters
NameTypeDescription
$enabledbool
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicsetProfile(\Zend_Tool_Project_Profile $profile) : \Zend_Tool_Project_Profile_Resource

setProfile()

Parameters
NameTypeDescription
$profile\Zend_Tool_Project_Profile
Returns
TypeDescription
\Zend_Tool_Project_Profile_Resource
methodpublicvalid() : bool
inherited

valid() - - required by RecursiveIterator

Inherited from: \Zend_Tool_Project_Profile_Resource_Container::valid()
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.