API Documentation

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

\Zend_Tool_Framework_Manifest_Repository

Package: Zend\Tool

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

Properties

Propertyprotectedarray  $_manifests= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_metadatas= 'array()'

Array of Zend_Tool_Framework_Metadata_Interface
Default valuearray()Details
Type
array
Propertyprotected\Zend_Tool_Framework_Provider_Registry_Interface  $_registry= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Provider_Registry_Interface

Methods

methodpublic__toString( ) : string

__toString() - cast to string

Returns
Type Description
string
methodpublicaddManifest( \Zend_Tool_Framework_Manifest_Interface $manifest ) : \Zend_Tool_Framework_Manifest_Repository

addManifest() - Add a manifest for later processing

Parameters
Name Type Description
$manifest \Zend_Tool_Framework_Manifest_Interface
Returns
Type Description
\Zend_Tool_Framework_Manifest_Repository
methodpublicaddMetadata( \Zend_Tool_Framework_Manifest_Metadata $metadata ) : \Zend_Tool_Framework_Manifest_Repository

addMetadata() - add a metadata peice by peice

Parameters
Name Type Description
$metadata \Zend_Tool_Framework_Manifest_Metadata
Returns
Type Description
\Zend_Tool_Framework_Manifest_Repository
methodpubliccount( ) : int

count() - required by the Countable Interface

Returns
Type Description
int
methodpublicgetIterator( ) : \ArrayIterator

getIterator() - required by the IteratorAggregate interface

Returns
Type Description
\ArrayIterator
methodpublicgetManifests( ) : \Zend_Tool_Framework_Manifest_Interface[]

getManifests()

methodpublicgetMetadata( array $searchProperties = array(), bool $includeNonExistentProperties = true ) : \Zend_Tool_Framework_Manifest_Metadata

getMetadata() - This will proxy to getMetadatas(), but will only return a single metadata. This method should be used in situations where the search criteria is known to only find a single metadata object

Parameters
Name Type Description
$searchProperties array
$includeNonExistentProperties bool
Returns
Type Description
\Zend_Tool_Framework_Manifest_Metadata
methodpublicgetMetadatas( array $searchProperties = array(), bool $includeNonExistentProperties = true ) : \Zend_Tool_Framework_Manifest_Metadata[]

getMetadatas() - This is the main search function for the repository.

example: This will retrieve all metadata that matches the following criteria $manifestRepo->getMetadatas(array( 'providerName' => 'Version', 'actionName' => 'show' ));

Parameters
Name Type Description
$searchProperties array
$includeNonExistentProperties bool
Returns
Type Description
\Zend_Tool_Framework_Manifest_Metadata[]
methodpublicprocess( ) : \Zend_Tool_Framework_Manifest_Repository

process() - Process is expected to be called at the end of client construction time.

By this time, the loader has run and loaded any found manifests into the repository for loading

Returns
Type Description
\Zend_Tool_Framework_Manifest_Repository
methodpublicsetRegistry( \Zend_Tool_Framework_Registry_Interface $registry ) : \unknown

setRegistry()

Parameters
Name Type Description
$registry \Zend_Tool_Framework_Registry_Interface
Returns
Type Description
\unknown
Documentation was generated by DocBlox 0.15.1.