Server/Definition.php

Show:

inherited

Classes
- \Zend_Server_Definition

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 [email protected] 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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Server_Definition
jump to top

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

array $_methods = array()

<p>Array of Zend_Server_Method_Definition objects</p>

Default valuearray()Details

Type: array

bool $_overwriteExistingMethods = false

<p>Whether or not overwriting existing methods is allowed</p>

Default valuefalseDetails

Type: bool

Methods

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

Constructor

Parameters

Name	Type	Description
$methods	null \| array

addMethod(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

addMethods(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

clearMethods() : \Zend_Server_Definition

Clear all method definitions

Returns

Type	Description
\Zend_Server_Definition

count() : int

Countable: count of methods

Returns

Type	Description
int

current() : mixed

Iterator: current item

Returns

Type	Description
mixed

getMethod(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

getMethods() : array

Get all method definitions

Returns

Type	Description
array	Array of Zend_Server_Method_Definition objects

hasMethod(string $method) : bool

Does the definition have the given method?

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
bool

key() : int | string

Iterator: current item key

Returns

Type	Description
int \| string

next() : void

Iterator: advance to next method

removeMethod(string $method) : \Zend_Server_Definition

Remove a method definition

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
\Zend_Server_Definition

rewind() : void

Iterator: return to first method

setMethods(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

setOverwriteExistingMethods(mixed $flag) : void

Set flag indicating whether or not overwriting existing methods is allowed

Parameters

Name	Type	Description
$flag	mixed

toArray() : array

Cast definition to an array

Returns

Type	Description
array

valid() : bool

Iterator: is the current index valid?

Returns

Type	Description
bool

Server/Definition.php

\Zend_Server_Definitionjump to top

Properties

Methods

\Zend_Server_Definition
jump to top