Zend_Server_Definition Class Reference

Inheritance diagram for Zend_Server_Definition:

Public Member Functions
	__construct ($methods=null)
	setOverwriteExistingMethods ($flag)
	addMethod ($method, $name=null)
	addMethods (array $methods)
	setMethods (array $methods)
	hasMethod ($method)
	getMethod ($method)
	getMethods ()
	removeMethod ($method)
	clearMethods ()
	toArray ()
	count ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()

Protected Attributes
	$_methods = array()
	$_overwriteExistingMethods = false

Detailed Description

Definition at line 31 of file Definition.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$methods = null

)

Constructor

Parameters

null | array

$methods

Returns

void

Definition at line 49 of file Definition.php.

    {
        if (is_array($methods)) {
            $this->setMethods($methods);
        }
    }

Member Function Documentation

addMethod()

addMethod	(		$method,
			$name = null
	)

Add method to definition

Parameters

array | Zend_Server_Method_Definition	$method
null | string	$name

Returns

Zend_Server_Definition

Exceptions

Zend_Server_Exception

if duplicate or invalid method provided

Definition at line 76 of file Definition.php.

    {
        if (is_array($method)) {
            #require_once 'Zend/Server/Method/Definition.php';
            $method = new Zend_Server_Method_Definition($method);
        } elseif (!$method instanceof Zend_Server_Method_Definition) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Invalid method provided');
        }

        if (is_numeric($name)) {
            $name = null;
        }
        if (null !== $name) {
            $method->setName($name);
        } else {
            $name = $method->getName();
        }
        if (null === $name) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('No method name provided');
        }

        if (!$this->_overwriteExistingMethods && array_key_exists($name, $this->_methods)) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception(sprintf('Method by name of "%s" already exists', $name));
        }
        $this->_methods[$name] = $method;
        return $this;
    }

addMethods()

addMethods

(

array

$methods

)

Add multiple methods

Parameters

array

$methods

Array of Zend_Server_Method_Definition objects or arrays

Returns

Zend_Server_Definition

Definition at line 113 of file Definition.php.

    {
        foreach ($methods as $key => $method) {
            $this->addMethod($method, $key);
        }
        return $this;
    }

clearMethods()

clearMethods

(

)

Clear all method definitions

Returns

Zend_Server_Definition

Definition at line 188 of file Definition.php.

    {
        $this->_methods = array();
        return $this;
    }

count()

count

(

)

Countable: count of methods

Returns

int

Definition at line 213 of file Definition.php.

    {
        return count($this->_methods);
    }

current()

current

(

)

Iterator: current item

Returns

mixed

Definition at line 223 of file Definition.php.

    {
        return current($this->_methods);
    }

getMethod()

getMethod

(

$method

)

Get a given method definition

Parameters

string

$method

Returns

null|Zend_Server_Method_Definition

Definition at line 151 of file Definition.php.

    {
        if ($this->hasMethod($method)) {
            return $this->_methods[$method];
        }
        return false;
    }

getMethods()

getMethods

(

)

Get all method definitions

Returns

array Array of Zend_Server_Method_Definition objects

Definition at line 164 of file Definition.php.

    {
        return $this->_methods;
    }

hasMethod()

hasMethod

(

$method

)

Does the definition have the given method?

Parameters

string

$method

Returns

bool

Definition at line 140 of file Definition.php.

    {
        return array_key_exists($method, $this->_methods);
    }

key()

key

(

)

Iterator: current item key

Returns

int|string

Definition at line 233 of file Definition.php.

    {
        return key($this->_methods);
    }

next()

next

(

)

Iterator: advance to next method

Returns

void

Definition at line 243 of file Definition.php.

    {
        return next($this->_methods);
    }

removeMethod()

removeMethod

(

$method

)

Remove a method definition

Parameters

string

$method

Returns

Zend_Server_Definition

Definition at line 175 of file Definition.php.

    {
        if ($this->hasMethod($method)) {
            unset($this->_methods[$method]);
        }
        return $this;
    }

rewind()

rewind

(

)

Iterator: return to first method

Returns

void

Definition at line 253 of file Definition.php.

    {
        return reset($this->_methods);
    }

setMethods()

setMethods

(

array

$methods

)

Set all methods at once (overwrite)

Parameters

array

$methods

Array of Zend_Server_Method_Definition objects or arrays

Returns

Zend_Server_Definition

Definition at line 127 of file Definition.php.

    {
        $this->clearMethods();
        $this->addMethods($methods);
        return $this;
    }

setOverwriteExistingMethods()

setOverwriteExistingMethods

(

$flag

)

Set flag indicating whether or not overwriting existing methods is allowed

Parameters

mixed

$flag

Returns

void

Definition at line 62 of file Definition.php.

    {
        $this->_overwriteExistingMethods = (bool) $flag;
        return $this;
    }

toArray()

toArray

(

)

Cast definition to an array

Returns

array

Definition at line 199 of file Definition.php.

    {
        $methods = array();
        foreach ($this->getMethods() as $key => $method) {
            $methods[$key] = $method->toArray();
        }
        return $methods;
    }

valid()

valid

(

)

Iterator: is the current index valid?

Returns

bool

Definition at line 263 of file Definition.php.

    {
        return (bool) $this->current();
    }

Field Documentation

$_methods

$_methods = array()

protected

Definition at line 36 of file Definition.php.

$_overwriteExistingMethods

$_overwriteExistingMethods = false

protected

Definition at line 41 of file Definition.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Server/Definition.php