Zend_Json_Server_Smd Class Reference

Public Member Functions
	setOptions (array $options)
	setTransport ($transport)
	getTransport ()
	setEnvelope ($envelopeType)
	getEnvelope ()
	setContentType ($type)
	getContentType ()
	setTarget ($target)
	getTarget ()
	setId ($id)
	getId ()
	setDescription ($description)
	getDescription ()
	setDojoCompatible ($flag)
	isDojoCompatible ()
	addService ($service)
	addServices (array $services)
	setServices (array $services)
	getService ($name)
	getServices ()
	removeService ($name)
	toArray ()
	toDojoArray ()
	toJson ()
	__toString ()

Data Fields
const	ENV_JSONRPC_1 = 'JSON-RPC-1.0'
const	ENV_JSONRPC_2 = 'JSON-RPC-2.0'
const	SMD_VERSION = '2.0'

Protected Attributes
	$_contentType = 'application/json'
	$_contentTypeRegex = '#[a-z]+/[a-z][a-z-]+#i'
	$_description
	$_dojoCompatible = false
	$_envelope = self::ENV_JSONRPC_1
	$_envelopeTypes
	$_id
	$_services = array()
	$_target
	$_transport = 'POST'
	$_transportTypes = array('POST')

Detailed Description

Definition at line 30 of file Smd.php.

Member Function Documentation

__toString()

__toString

(

)

Cast to string (JSON)

Returns

string

Definition at line 475 of file Smd.php.

    {
        return $this->toJson();
    }

addService()

addService

(

$service

)

Add Service

Parameters

Zend_Json_Server_Smd_Service | array

$service

Returns

void

Definition at line 296 of file Smd.php.

    {
        #require_once 'Zend/Json/Server/Smd/Service.php';

        if ($service instanceof Zend_Json_Server_Smd_Service) {
            $name = $service->getName();
        } elseif (is_array($service)) {
            $service = new Zend_Json_Server_Smd_Service($service);
            $name = $service->getName();
        } else {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Invalid service passed to addService()');
        }

        if (array_key_exists($name, $this->_services)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception('Attempt to register a service already registered detected');
        }
        $this->_services[$name] = $service;
        return $this;
    }

addServices()

addServices

(

array

$services

)

Add many services

Parameters

array

$services

Returns

Zend_Json_Server_Smd

Definition at line 324 of file Smd.php.

    {
        foreach ($services as $service) {
            $this->addService($service);
        }
        return $this;
    }

getContentType()

getContentType

(

)

Retrieve content type

Returns

string

Definition at line 197 of file Smd.php.

    {
        return $this->_contentType;
    }

getDescription()

getDescription

(

)

Get service description

Returns

string

Definition at line 263 of file Smd.php.

    {
        return $this->_description;
    }

getEnvelope()

getEnvelope

(

)

Retrieve envelope

Returns

string

Definition at line 170 of file Smd.php.

    {
        return $this->_envelope;
    }

getId()

getId

(

)

Get service id

Returns

string

Definition at line 241 of file Smd.php.

    {
        return $this->_id;
    }

getService()

getService

(

$name

)

Get service object

Parameters

string

$name

Returns

false|Zend_Json_Server_Smd_Service

Definition at line 350 of file Smd.php.

    {
        if (array_key_exists($name, $this->_services)) {
            return $this->_services[$name];
        }
        return false;
    }

getServices()

getServices

(

)

Return services

Returns

array

Definition at line 363 of file Smd.php.

    {
        return $this->_services;
    }

getTarget()

getTarget

(

)

Retrieve service target

Returns

string

Definition at line 219 of file Smd.php.

    {
        return $this->_target;
    }

getTransport()

getTransport

(

)

Get transport

Returns

string

Definition at line 144 of file Smd.php.

    {
        return $this->_transport;
    }

isDojoCompatible()

isDojoCompatible

(

)

Is this a Dojo compatible SMD?

Returns

bool

Definition at line 285 of file Smd.php.

    {
        return $this->_dojoCompatible;
    }

removeService()

removeService

(

$name

)

Remove service

Parameters

string

$name

Returns

boolean

Definition at line 374 of file Smd.php.

    {
        if (array_key_exists($name, $this->_services)) {
            unset($this->_services[$name]);
            return true;
        }
        return false;
    }

setContentType()

setContentType

(

$type

)

Set content type

Parameters

string

$type

Returns

Zend_Json_Server_Smd

Definition at line 182 of file Smd.php.

    {
        if (!preg_match($this->_contentTypeRegex, $type)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception(sprintf('Invalid content type "%s" specified', $type));
        }
        $this->_contentType = $type;
        return $this;
    }

setDescription()

setDescription

(

$description

)

Set service description

Parameters

string

$description

Returns

Zend_Json_Server_Smd

Definition at line 252 of file Smd.php.

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

setDojoCompatible()

setDojoCompatible

(

$flag

)

Indicate whether or not to generate Dojo-compatible SMD

Parameters

bool

$flag

Returns

Zend_Json_Server_Smd

Definition at line 274 of file Smd.php.

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

setEnvelope()

setEnvelope

(

$envelopeType

)

Set envelope

Parameters

string

$envelopeType

Returns

Zend_Json_Server_Smd

Definition at line 155 of file Smd.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"', $envelopeType));
        }
        $this->_envelope = $envelopeType;
        return $this;
    }

setId()

setId

(

$id

)

Set service ID

Parameters

string

$Id

Returns

Zend_Json_Server_Smd

Definition at line 230 of file Smd.php.

    {
        $this->_id = (string) $id;
        return $this->_id;
    }

setOptions()

setOptions

(

array

$options

)

Set object state via options

Parameters

array

$options

Returns

Zend_Json_Server_Smd

Definition at line 111 of file Smd.php.

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

setServices()

setServices

(

array

$services

)

Overwrite existing services with new ones

Parameters

array

$services

Returns

Zend_Json_Server_Smd

Definition at line 338 of file Smd.php.

    {
        $this->_services = array();
        return $this->addServices($services);
    }

setTarget()

setTarget

(

$target

)

Set service target

Parameters

string

$target

Returns

Zend_Json_Server_Smd

Definition at line 208 of file Smd.php.

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

setTransport()

setTransport

(

$transport

)

Set transport

Parameters

string

$transport

Returns

Zend_Json_Server_Smd

Definition at line 129 of file Smd.php.

    {
        if (!in_array($transport, $this->_transportTypes)) {
            #require_once 'Zend/Json/Server/Exception.php';
            throw new Zend_Json_Server_Exception(sprintf('Invalid transport "%s" specified', $transport));
        }
        $this->_transport = $transport;
        return $this;
    }

toArray()

toArray

(

)

Cast to array

Returns

array

Definition at line 388 of file Smd.php.

    {
        if ($this->isDojoCompatible()) {
            return $this->toDojoArray();
        }

        $transport   = $this->getTransport();
        $envelope    = $this->getEnvelope();
        $contentType = $this->getContentType();
        $SMDVersion  = self::SMD_VERSION;
        $service = compact('transport', 'envelope', 'contentType', 'SMDVersion');

        if (null !== ($target = $this->getTarget())) {
            $service['target']     = $target;
        }
        if (null !== ($id = $this->getId())) {
            $service['id'] = $id;
        }

        $services = $this->getServices();
        if (!empty($services)) {
            $service['services'] = array();
            foreach ($services as $name => $svc) {
                $svc->setEnvelope($envelope);
                $service['services'][$name] = $svc->toArray();
            }
            $service['methods'] = $service['services'];
        }

        return $service;
    }

toDojoArray()

toDojoArray

(

)

Export to DOJO-compatible SMD array

Returns

array

Definition at line 425 of file Smd.php.

    {
        $SMDVersion  = '.1';
        $serviceType = 'JSON-RPC';
        $service = compact('SMDVersion', 'serviceType');

        $target = $this->getTarget();

        $services = $this->getServices();
        if (!empty($services)) {
            $service['methods'] = array();
            foreach ($services as $name => $svc) {
                $method = array(
                    'name'       => $name,
                    'serviceURL' => $target,
                );
                $params = array();
                foreach ($svc->getParams() as $param) {
                    $paramName = array_key_exists('name', $param) ? $param['name'] : $param['type'];
                    $params[] = array(
                        'name' => $paramName,
                        'type' => $param['type'],
                    );
                }
                if (!empty($params)) {
                    $method['parameters'] = $params;
                }
                $service['methods'][] = $method;
            }
        }

        return $service;
    }

toJson()

toJson

(

)

Cast to JSON

Returns

string

Definition at line 464 of file Smd.php.

    {
        #require_once 'Zend/Json.php';
        return Zend_Json::encode($this->toArray());
    }

Field Documentation

$_contentType

$_contentType = 'application/json'

protected

Definition at line 40 of file Smd.php.

$_contentTypeRegex

$_contentTypeRegex = '#[a-z]+/[a-z][a-z-]+#i'

protected

Definition at line 46 of file Smd.php.

$_description

$_description

protected

Definition at line 52 of file Smd.php.

$_dojoCompatible

$_dojoCompatible = false

protected

Definition at line 58 of file Smd.php.

$_envelope

$_envelope = self::ENV_JSONRPC_1

protected

Definition at line 64 of file Smd.php.

$_envelopeTypes

$_envelopeTypes

protected

Initial value:

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

Definition at line 70 of file Smd.php.

$_id

$_id

protected

Definition at line 79 of file Smd.php.

$_services

$_services = array()

protected

Definition at line 85 of file Smd.php.

$_target

$_target

protected

Definition at line 91 of file Smd.php.

$_transport

$_transport = 'POST'

protected

Definition at line 97 of file Smd.php.

$_transportTypes

$_transportTypes = array('POST')

protected

Definition at line 103 of file Smd.php.

ENV_JSONRPC_1

const ENV_JSONRPC_1 = 'JSON-RPC-1.0'

Definition at line 32 of file Smd.php.

ENV_JSONRPC_2

const ENV_JSONRPC_2 = 'JSON-RPC-2.0'

Definition at line 33 of file Smd.php.

SMD_VERSION

const SMD_VERSION = '2.0'

Definition at line 34 of file Smd.php.

---

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

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