Zend_Json_Server_Smd_Service Class Reference

Public Member Functions
	__construct ($spec)
	setOptions (array $options)
	setName ($name)
	getName ()
	setTransport ($transport)
	getTransport ()
	setTarget ($target)
	getTarget ()
	setEnvelope ($envelopeType)
	getEnvelope ()
	addParam ($type, array $options=array(), $order=null)
	addParams (array $params)
	setParams (array $params)
	getParams ()
	setReturn ($type)
	getReturn ()
	toArray ()
	toJson ()
	__toString ()

Protected Member Functions
	_validateParamType ($type, $isReturn=false)

Protected Attributes
	$_envelope = Zend_Json_Server_Smd::ENV_JSONRPC_1
	$_name
	$_return
	$_target
	$_transport = 'POST'
	$_envelopeTypes
	$_nameRegex = '/^[a-z][a-z0-9._]+$/i'
	$_paramOptionTypes
	$_params = array()
	$_paramMap
	$_transportTypes

Detailed Description

Definition at line 35 of file Service.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$spec

)

Constructor

Parameters

string | array

$spec

Returns

void

Exceptions

Zend_Json_Server_Exception

if no name provided

Definition at line 124 of file Service.php.

    {
        if (is_string($spec)) {
            $this->setName($spec);
        } elseif (is_array($spec)) {
            $this->setOptions($spec);
        }

        if (null == $this->getName()) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('SMD service description requires a name; none provided');
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Cast to string

Returns

string

Definition at line 442 of file Service.php.

    {
        return $this->toJson();
    }

_validateParamType()

_validateParamType (   $type,   $isReturn = false  )

protected

Validate parameter type

Parameters

string

$type

Returns

true

Exceptions

Zend_Json_Server_Exception

Definition at line 454 of file Service.php.

    {
        if (!is_string($type)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid param type provided ("' . $type .'")');
        }

        if (!array_key_exists($type, $this->_paramMap)) {
            $type = 'object';
        }

        $paramType = $this->_paramMap[$type];
        if (!$isReturn && ('null' == $paramType)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid param type provided ("' . $type . '")');
        }

        return $paramType;
    }

addParam()

addParam	(		$type,
		array	$options = array(),
			$order = null
	)

Add a parameter to the service

Parameters

string | array	$type
array	$options
int | null	$order

Returns

Zend_Json_Server_Smd_Service

Definition at line 273 of file Service.php.

    {
        if (is_string($type)) {
            $type = $this->_validateParamType($type);
        } elseif (is_array($type)) {
            foreach ($type as $key => $paramType) {
                $type[$key] = $this->_validateParamType($paramType);
            }
        } else {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid param type provided');
        }

        $paramOptions = array(
            'type' => $type,
        );
        foreach ($options as $key => $value) {
            if (in_array($key, array_keys($this->_paramOptionTypes))) {
                if (null !== ($callback = $this->_paramOptionTypes[$key])) {
                    if (!$callback($value)) {
                        continue;
                    }
                }
                $paramOptions[$key] = $value;
            }
        }

        $this->_params[] = array(
            'param' => $paramOptions,
            'order' => $order,
        );

        return $this;
    }

addParams()

addParams

(

array

$params

)

Add params

Each param should be an array, and should include the key 'type'.

Parameters

array

$params

Returns

Zend_Json_Server_Smd_Service

Definition at line 316 of file Service.php.

    {
        ksort($params);
        foreach ($params as $options) {
            if (!is_array($options)) {
                continue;
            }
            if (!array_key_exists('type', $options)) {
                continue;
            }
            $type  = $options['type'];
            $order = (array_key_exists('order', $options)) ? $options['order'] : null;
            $this->addParam($type, $options, $order);
        }
        return $this;
    }

getEnvelope()

getEnvelope

(

)

Get envelope type

Returns

string

Definition at line 260 of file Service.php.

    {
        return $this->_envelope;
    }

getName()

getName

(

)

Retrieve name

Returns

string

Definition at line 182 of file Service.php.

    {
        return $this->_name;
    }

getParams()

getParams

(

)

Get all parameters

Returns all params in specified order.

Returns

array

Definition at line 352 of file Service.php.

    {
        $params = array();
        $index  = 0;
        foreach ($this->_params as $param) {
            if (null === $param['order']) {
                if (array_search($index, array_keys($params), true)) {
                    ++$index;
                }
                $params[$index] = $param['param'];
                ++$index;
            } else {
                $params[$param['order']] = $param['param'];
            }
        }
        ksort($params);
        return $params;
    }

getReturn()

getReturn

(

)

Get return type

Returns

string|array

Definition at line 398 of file Service.php.

    {
        return $this->_return;
    }

getTarget()

getTarget

(

)

Get service target

Returns

string

Definition at line 233 of file Service.php.

    {
        return $this->_target;
    }

getTransport()

getTransport

(

)

Get transport

Returns

string

Definition at line 211 of file Service.php.

    {
        return $this->_transport;
    }

setEnvelope()

setEnvelope

(

$envelopeType

)

Set envelope type

Parameters

string

$envelopeType

Returns

Zend_Json_Server_Smd_Service

Definition at line 244 of file Service.php.

    {
        if (!in_array($envelopeType, $this->_envelopeTypes)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception(sprintf('Invalid envelope type "%s"; please specify one of (%s)', $envelopeType, implode(', ', $this->_envelopeTypes)));
        }

        $this->_envelope = $envelopeType;
        return $this;
    }

setName()

setName

(

$name

)

Set service name

Parameters

string

$name

Returns

Zend_Json_Server_Smd_Service

Exceptions

Zend_Json_Server_Exception

Definition at line 166 of file Service.php.

    {
        $name = (string) $name;
        if (!preg_match($this->_nameRegex, $name)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception(sprintf('Invalid name "%s" provided for service; must follow PHP method naming conventions', $name));
        }
        $this->_name = $name;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set object state

Parameters

array

$options

Returns

Zend_Json_Server_Smd_Service

Definition at line 144 of file Service.php.

    {
        $methods = get_class_methods($this);
        foreach ($options as $key => $value) {
            if ('options' == strtolower($key)) {
                continue;
            }
            $method = 'set' . ucfirst($key);
            if (in_array($method, $methods)) {
                $this->$method($value);
            }
        }
        return $this;
    }

setParams()

setParams

(

array

$params

)

Overwrite all parameters

Parameters

array

$params

Returns

Zend_Json_Server_Smd_Service

Definition at line 339 of file Service.php.

    {
        $this->_params = array();
        return $this->addParams($params);
    }

setReturn()

setReturn

(

$type

)

Set return type

Parameters

string | array

$type

Returns

Zend_Json_Server_Smd_Service

Definition at line 377 of file Service.php.

    {
        if (is_string($type)) {
            $type = $this->_validateParamType($type, true);
        } elseif (is_array($type)) {
            foreach ($type as $key => $returnType) {
                $type[$key] = $this->_validateParamType($returnType, true);
            }
        } else {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid param type provided ("' . gettype($type) .'")');
        }
        $this->_return = $type;
        return $this;
    }

setTarget()

setTarget

(

$target

)

Set service target

Parameters

string

$target

Returns

Zend_Json_Server_Smd_Service

Definition at line 222 of file Service.php.

    {
        $this->_target = (string) $target;
        return $this;
    }

setTransport()

setTransport

(

$transport

)

Set Transport

Currently limited to POST

Parameters

string

$transport

Returns

Zend_Json_Server_Smd_Service

Definition at line 195 of file Service.php.

    {
        if (!in_array($transport, $this->_transportTypes)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception(sprintf('Invalid transport "%s"; please select one of (%s)', $transport, implode(', ', $this->_transportTypes)));
        }

        $this->_transport = $transport;
        return $this;
    }

toArray()

toArray

(

)

Cast service description to array

Returns

array

Definition at line 408 of file Service.php.

    {
        $name       = $this->getName();
        $envelope   = $this->getEnvelope();
        $target     = $this->getTarget();
        $transport  = $this->getTransport();
        $parameters = $this->getParams();
        $returns    = $this->getReturn();

        if (empty($target)) {
            return compact('envelope', 'transport', 'parameters', 'returns');
        }

        return $paramInfo = compact('envelope', 'target', 'transport', 'parameters', 'returns');
    }

toJson()

toJson

(

)

Return JSON encoding of service

Returns

string

Definition at line 429 of file Service.php.

    {
        $service = array($this->getName() => $this->toArray());

        #require_once 'Zend/Json.php';
        return Zend_Json::encode($service);
    }

Field Documentation

$_envelope

$_envelope = Zend_Json_Server_Smd::ENV_JSONRPC_1

protected

Definition at line 41 of file Service.php.

$_envelopeTypes

$_envelopeTypes

protected

Initial value:

= array(
        Zend_Json_Server_Smd::ENV_JSONRPC_1,
        Zend_Json_Server_Smd::ENV_JSONRPC_2,
    )

Definition at line 52 of file Service.php.

$_name

$_name

protected

Definition at line 42 of file Service.php.

$_nameRegex

$_nameRegex = '/^[a-z][a-z0-9._]+$/i'

protected

Definition at line 61 of file Service.php.

$_paramMap

$_paramMap

protected

Initial value:

= array(
        'any'     => 'any',
        'arr'     => 'array',
        'array'   => 'array',
        'assoc'   => 'object',
        'bool'    => 'boolean',
        'boolean' => 'boolean',
        'dbl'     => 'float',
        'double'  => 'float',
        'false'   => 'boolean',
        'float'   => 'float',
        'hash'    => 'object',
        'integer' => 'integer',
        'int'     => 'integer',
        'mixed'   => 'any',
        'nil'     => 'null',
        'null'    => 'null',
        'object'  => 'object',
        'string'  => 'string',
        'str'     => 'string',
        'struct'  => 'object',
        'true'    => 'boolean',
        'void'    => 'null',
    )

Definition at line 84 of file Service.php.

$_paramOptionTypes

$_paramOptionTypes

protected

Initial value:

= array(
        'name'        => 'is_string',
        'optional'    => 'is_bool',
        'default'     => null,
        'description' => 'is_string',
    )

Definition at line 67 of file Service.php.

$_params

$_params = array()

protected

Definition at line 78 of file Service.php.

$_return

$_return

protected

Definition at line 43 of file Service.php.

$_target

$_target

protected

Definition at line 44 of file Service.php.

$_transport

$_transport = 'POST'

protected

Definition at line 45 of file Service.php.

$_transportTypes

$_transportTypes

protected

Initial value:

= array(
        'POST',
    )

Definition at line 113 of file Service.php.

---

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

• vendor/magento/zendframework1/library/Zend/Json/Server/Smd/Service.php