API Documentation

Server/Definition.php

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_Server
version
$Id: Definition.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Server_Definition

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_Server_Definition
jump to top

Implements
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_Server
todo
Implement iterator
Properties
$_methods
$_overwriteExistingMethods
Methods
__construct
setOverwriteExistingMethods
addMethod
addMethods
setMethods
hasMethod
getMethod
getMethods
removeMethod
clearMethods
toArray
count
current
key
next
rewind
valid

Description

Server methods metadata

Properties

$_methods
jump to class

array $_methods = 'array'

Details

$_methods
array
Array of Zend_Server_Method_Definition objects
visibility
protected
default
array
final
false
static
false

$_overwriteExistingMethods
jump to class

bool $_overwriteExistingMethods = 'false'

Details

$_overwriteExistingMethods
bool
Whether or not overwriting existing methods is allowed
visibility
protected
default
false
final
false
static
false

Methods

__construct
jump to class

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

Constructor

Arguments
$methods
nullarray
Details
visibility
public
final
false
static
false

addMethod
jump to class

addMethod( array|Zend_Server_Method_Definition $method, null|string $name = null ) : Zend_Server_Definition

Add method to definition

Arguments
$method
arrayZend_Server_Method_Definition
$name
nullstring
Output
Zend_Server_Definition
Details
visibility
public
final
false
static
false
throws
if duplicate or invalid method provided

addMethods
jump to class

addMethods( array $methods ) : Zend_Server_Definition

Add multiple methods

Arguments
$methods
array
Array of Zend_Server_Method_Definition objects or arrays
Output
Zend_Server_Definition
Details
visibility
public
final
false
static
false

clearMethods
jump to class

clearMethods( ) : Zend_Server_Definition

Clear all method definitions

Output
Zend_Server_Definition
Details
visibility
public
final
false
static
false

count
jump to class

count( ) : int

Countable: count of methods

Output
int
Details
visibility
public
final
false
static
false

current
jump to class

current( ) : mixed

Iterator: current item

Output
mixed
Details
visibility
public
final
false
static
false

getMethod
jump to class

getMethod( string $method ) : null|Zend_Server_Method_Definition

Get a given method definition

Arguments
$method
string
Output
null|Zend_Server_Method_Definition
Details
visibility
public
final
false
static
false

getMethods
jump to class

getMethods( ) : array

Get all method definitions

Output
array
Array of Zend_Server_Method_Definition objects
Details
visibility
public
final
false
static
false

hasMethod
jump to class

hasMethod( string $method ) : bool

Does the definition have the given method?

Arguments
$method
string
Output
bool
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : int|string

Iterator: current item key

Output
int|string
Details
visibility
public
final
false
static
false

next
jump to class

next( ) : void

Iterator: advance to next method

Details
visibility
public
final
false
static
false

removeMethod
jump to class

removeMethod( string $method ) : Zend_Server_Definition

Remove a method definition

Arguments
$method
string
Output
Zend_Server_Definition
Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) : void

Iterator: return to first method

Details
visibility
public
final
false
static
false

setMethods
jump to class

setMethods( array $methods ) : Zend_Server_Definition

Set all methods at once (overwrite)

Arguments
$methods
array
Array of Zend_Server_Method_Definition objects or arrays
Output
Zend_Server_Definition
Details
visibility
public
final
false
static
false

setOverwriteExistingMethods
jump to class

setOverwriteExistingMethods( mixed $flag ) : void

Set flag indicating whether or not overwriting existing methods is allowed

Arguments
$flag
mixed
Details
visibility
public
final
false
static
false

toArray
jump to class

toArray( ) : array

Cast definition to an array

Output
array
Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : bool

Iterator: is the current index valid?

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