Zend_Server_Method_Parameter Class Reference

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	setDefaultValue ($defaultValue)
	getDefaultValue ()
	setDescription ($description)
	getDescription ()
	setName ($name)
	getName ()
	setOptional ($flag)
	isOptional ()
	setType ($type)
	getType ()
	toArray ()

Protected Attributes
	$_defaultValue
	$_description = ''
	$_name
	$_optional = false
	$_type = 'mixed'

Detailed Description

Definition at line 32 of file Parameter.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

null | array

$options

Returns

void

Definition at line 65 of file Parameter.php.

    {
        if (is_array($options)) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

getDefaultValue()

getDefaultValue

(

)

Retrieve default value

Returns

mixed

Definition at line 106 of file Parameter.php.

    {
        return $this->_defaultValue;
    }

getDescription()

getDescription

(

)

Retrieve description

Returns

string

Definition at line 128 of file Parameter.php.

    {
        return $this->_description;
    }

getName()

getName

(

)

Retrieve name

Returns

string

Definition at line 150 of file Parameter.php.

    {
        return $this->_name;
    }

getType()

getType

(

)

Retrieve parameter type

Returns

string

Definition at line 194 of file Parameter.php.

    {
        return $this->_type;
    }

isOptional()

isOptional

(

)

Is the parameter optional?

Returns

bool

Definition at line 172 of file Parameter.php.

    {
        return $this->_optional;
    }

setDefaultValue()

setDefaultValue

(

$defaultValue

)

Set default value

Parameters

mixed

$defaultValue

Returns

Zend_Server_Method_Parameter

Definition at line 95 of file Parameter.php.

    {
        $this->_defaultValue = $defaultValue;
        return $this;
    }

setDescription()

setDescription

(

$description

)

Set description

Parameters

string

$description

Returns

Zend_Server_Method_Parameter

Definition at line 117 of file Parameter.php.

    {
        $this->_description = (string) $description;
        return $this;
    }

setName()

setName

(

$name

)

Set name

Parameters

string

$name

Returns

Zend_Server_Method_Parameter

Definition at line 139 of file Parameter.php.

    {
        $this->_name = (string) $name;
        return $this;
    }

setOptional()

setOptional

(

$flag

)

Set optional flag

Parameters

bool

$flag

Returns

Zend_Server_Method_Parameter

Definition at line 161 of file Parameter.php.

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

setOptions()

setOptions

(

array

$options

)

Set object state from array of options

Parameters

array

$options

Returns

Zend_Server_Method_Parameter

Definition at line 78 of file Parameter.php.

    {
        foreach ($options as $key => $value) {
            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }
        return $this;
    }

setType()

setType

(

$type

)

Set parameter type

Parameters

string

$type

Returns

Zend_Server_Method_Parameter

Definition at line 183 of file Parameter.php.

    {
        $this->_type = (string) $type;
        return $this;
    }

toArray()

toArray

(

)

Cast to array

Returns

array

Definition at line 204 of file Parameter.php.

    {
        return array(
            'type'         => $this->getType(),
            'name'         => $this->getName(),
            'optional'     => $this->isOptional(),
            'defaultValue' => $this->getDefaultValue(),
            'description'  => $this->getDescription(),
        );
    }

Field Documentation

$_defaultValue

$_defaultValue

protected

Definition at line 37 of file Parameter.php.

$_description

$_description = ''

protected

Definition at line 42 of file Parameter.php.

$_name

$_name

protected

Definition at line 47 of file Parameter.php.

$_optional

$_optional = false

protected

Definition at line 52 of file Parameter.php.

$_type

$_type = 'mixed'

protected

Definition at line 57 of file Parameter.php.

---

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

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