Zend_Server_Reflection_Parameter Class Reference

Public Member Functions
	__construct (ReflectionParameter $r, $type='mixed', $description='')
	__call ($method, $args)
	getType ()
	setType ($type)
	getDescription ()
	setDescription ($description)
	setPosition ($index)
	getPosition ()

Protected Attributes
	$_reflection
	$_position
	$_type
	$_description

Detailed Description

Definition at line 33 of file Parameter.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ReflectionParameter	$r,
			$type = 'mixed',
			$description = ''
	)

Constructor

Parameters

ReflectionParameter	$r
string	$type	Parameter type
string	$description	Parameter description

Definition at line 65 of file Parameter.php.

    {
        $this->_reflection = $r;
        $this->setType($type);
        $this->setDescription($description);
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Proxy reflection calls

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 79 of file Parameter.php.

    {
        if (method_exists($this->_reflection, $method)) {
            return call_user_func_array(array($this->_reflection, $method), $args);
        }

        #require_once 'Zend/Server/Reflection/Exception.php';
        throw new Zend_Server_Reflection_Exception('Invalid reflection method');
    }

getDescription()

getDescription

(

)

Retrieve parameter description

Returns

string

Definition at line 120 of file Parameter.php.

    {
        return $this->_description;
    }

getPosition()

getPosition

(

)

Return parameter position

Returns

int

Definition at line 157 of file Parameter.php.

    {
        return $this->_position;
    }

getType()

getType

(

)

Retrieve parameter type

Returns

string

Definition at line 94 of file Parameter.php.

    {
        return $this->_type;
    }

setDescription()

setDescription

(

$description

)

Set parameter description

Parameters

string | null

$description

Returns

void

Definition at line 131 of file Parameter.php.

    {
        if (!is_string($description) && (null !== $description)) {
            #require_once 'Zend/Server/Reflection/Exception.php';
            throw new Zend_Server_Reflection_Exception('Invalid parameter description');
        }

        $this->_description = $description;
    }

setPosition()

setPosition

(

$index

)

Set parameter position

Parameters

int

$index

Returns

void

Definition at line 147 of file Parameter.php.

    {
        $this->_position = (int) $index;
    }

setType()

setType

(

$type

)

Set parameter type

Parameters

string | null

$type

Returns

void

Definition at line 105 of file Parameter.php.

    {
        if (!is_string($type) && (null !== $type)) {
            #require_once 'Zend/Server/Reflection/Exception.php';
            throw new Zend_Server_Reflection_Exception('Invalid parameter type');
        }

        $this->_type = $type;
    }

Field Documentation

$_description

$_description

protected

Definition at line 56 of file Parameter.php.

$_position

$_position

protected

Definition at line 44 of file Parameter.php.

$_reflection

$_reflection

protected

Definition at line 38 of file Parameter.php.

$_type

$_type

protected

Definition at line 50 of file Parameter.php.

---

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

• vendor/magento/zendframework1/library/Zend/Server/Reflection/Parameter.php