API Documentation

Zend/Server/Definition.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_Server  
Version
$Id: Definition.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Server_Definition

Package: Zend\Server

Server methods metadata

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

Properties

Propertyprotectedarray  $_methods= 'array()'

Array of Zend_Server_Method_Definition objects
Default valuearray()Details
Type
array
Propertyprotectedbool  $_overwriteExistingMethods= 'false'

Whether or not overwriting existing methods is allowed
Default valuefalseDetails
Type
bool

Methods

methodpublic__construct( null|array $methods = null ) : void

Constructor

Parameters
Name Type Description
$methods null|array
methodpublicaddMethod( array|\Zend_Server_Method_Definition $method, null|string $name = null ) : \Zend_Server_Definition

Add method to definition

Parameters
Name Type Description
$method array|\Zend_Server_Method_Definition
$name null|string
Returns
Type Description
\Zend_Server_Definition
Throws
Exception Description
\Zend_Server_Exception if duplicate or invalid method provided
methodpublicaddMethods( array $methods ) : \Zend_Server_Definition

Add multiple methods

Parameters
Name Type Description
$methods array

Array of Zend_Server_Method_Definition objects or arrays

Returns
Type Description
\Zend_Server_Definition
methodpublicclearMethods( ) : \Zend_Server_Definition

Clear all method definitions

Returns
Type Description
\Zend_Server_Definition
methodpubliccount( ) : int

Countable: count of methods

Returns
Type Description
int
methodpubliccurrent( ) : mixed

Iterator: current item

Returns
Type Description
mixed
methodpublicgetMethod( string $method ) : null|\Zend_Server_Method_Definition

Get a given method definition

Parameters
Name Type Description
$method string
Returns
Type Description
null|\Zend_Server_Method_Definition
methodpublicgetMethods( ) : array

Get all method definitions

Returns
Type Description
array Array of Zend_Server_Method_Definition objects
methodpublichasMethod( string $method ) : bool

Does the definition have the given method?

Parameters
Name Type Description
$method string
Returns
Type Description
bool
methodpublickey( ) : int|string

Iterator: current item key

Returns
Type Description
int|string
methodpublicnext( ) : void

Iterator: advance to next method

methodpublicremoveMethod( string $method ) : \Zend_Server_Definition

Remove a method definition

Parameters
Name Type Description
$method string
Returns
Type Description
\Zend_Server_Definition
methodpublicrewind( ) : void

Iterator: return to first method

methodpublicsetMethods( array $methods ) : \Zend_Server_Definition

Set all methods at once (overwrite)

Parameters
Name Type Description
$methods array

Array of Zend_Server_Method_Definition objects or arrays

Returns
Type Description
\Zend_Server_Definition
methodpublicsetOverwriteExistingMethods( mixed $flag ) : void

Set flag indicating whether or not overwriting existing methods is allowed

Parameters
Name Type Description
$flag mixed
methodpublictoArray( ) : array

Cast definition to an array

Returns
Type Description
array
methodpublicvalid( ) : bool

Iterator: is the current index valid?

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.