model/modx/transport/modtransportprovider.class.php
- package
- modx
- subpackage
- transport
- Classes
- modTransportProvider
Description
\modTransportProvider
- Extends from
- \xPDOSimpleObject
- package
- xpdo
- uses
- modRestClient This REST implementation is used to communicate with a remote server that can provide information about and downloads of one or more MODX transport packages.
- Methods
- getClient
- handleResponse
- request
- save
- verify
Description
Represents a remote transport package provider service.
This is the basis for the entire xPDO object model, and can also be used by a class generator {@link xPDOGenerator}, ultimately allowing custom classes to be user-defined in a web interface and framework-generated at runtime.
Methods
getClient
getClient(
)
:
\jsonrpc_client
Get the client responsible for communicating with the provider.
Output
- \jsonrpc_client
- The JSON-RPC client instance.
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
handleResponse
handleResponse(
\jsonrpcresp $response
)
:
array
Handles the response from the provider. Returns response in array format.
Arguments
- $response
- \jsonrpcresp
The json-rpc response.
Output
- array
- The parsed response.
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
- deprecated
- 2.0.0-rc1 - Jan 14, 2010
request
request(
string $path, string $method
=
GET, array $params
=
array
)
:
mixed
Sends a REST request to the provider
Arguments
- $path
- string
The path of the request - $method
- string
The method of the request (GET/POST) - $params
- array
An array of parameters to send to the REST request
Output
- mixed
- The response from the REST request
Details
- visibility
- public
- final
- false
- static
- false
save
save(
boolean $cacheFlag
=
null
)
:
boolean
Overrides xPDOObject::save to set the createdon date.
{@inheritdoc}
Arguments
- $cacheFlag
- boolean
Output
- boolean
- True if successful
Details
- visibility
- public
- final
- false
- static
- false
verify
verify(
)
:
boolean
Verifies the authenticity of the provider
Output
- boolean
- True if verified, xml if failed
Details
- visibility
- public
- final
- false
- static
- false
- access
- public