OSS » \OSS_Service

category	OSS
package	OSS_Service
copyright	Copyright (c) 2007 - 2012, Open Source Solutions Limited, Dublin, Ireland
license	New BSD License

Methods

Method overloading

__call(string $method, array $params) : mixed

Parameters

$method

string

$params

array

Exceptions

`\Zend_Service_Exception`	if unable to find method

Returns

mixed

Constructor

__construct(array $options, \Zend_Oauth_Consumer $consumer) : void

Parameters

$options

array

Options array

$consumer

null\Zend_Oauth_Consumer

Optional consumer

Proxy service methods

__get(string $type) : \OSS_Service_Freshbooks

Parameters

$type

string

Exceptions

`\Zend_Service_Exception`	If method not in method types list

Returns

\OSS_Service_Freshbooks

Public client create

clientCreate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public client delete

clientDelete(int $client_id) : \Zend_Rest_Client_Result

Parameters

$client_id

int

Id of the client

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public client get

clientGet(int $client_id) : \Zend_Rest_Client_Result

Parameters

$client_id

int

Id of the client

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public client list

clientList($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public client create

clientUpdate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Get the local HTTP client as distinct from the static HTTP client inherited from Zend_Rest_Client

getLocalHttpClient() : \Zend_Http_Client

Returns

\Zend_Http_Client

Retrieve username

getSubdomain() : string

Returns

string

Public invoice create

invoiceCreate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice delete

invoiceDelete(int $invoice_id) : \Zend_Rest_Client_Result

Parameters

$invoice_id

int

Id of the invoice

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice get

invoiceGet(int $invoice_id) : \Zend_Rest_Client_Result

Parameters

$invoice_id

int

Id of the invoice

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice lines add

invoiceLinesAdd($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice line delete

invoiceLinesDelete(int $invoice_id, int $line_id) : \Zend_Rest_Client_Result

Parameters

$invoice_id

int

Id of the invoice

$line_id

int

Id of the line to delete

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice lines update

invoiceLinesUpdate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice list

invoiceList($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice send by email

invoiceSendByEmail(int $invoice_id, string $subject, string $message) : \Zend_Rest_Client_Result

Parameters

$invoice_id

int

Id of the invoice

$subject

string

Email subject

$message

string

Email body to add invoice link write '::invoice link::'.

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public invoice update

invoiceUpdate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Checks for an authorised state

isAuthorised() : bool

Returns

bool

Public recurring create

recurringCreate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring delete

recurringDelete(int $recurring_id) : \Zend_Rest_Client_Result

Parameters

$recurring_id

int

Id of the recurring

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring get

recurringGet(int $recurring_id) : \Zend_Rest_Client_Result

Parameters

$recurring_id

int

Id of the recurring

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring lines add

recurringLinesAdd($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring line delete

recurringLinesDelete(int $recurring_id, int $line_id) : \Zend_Rest_Client_Result

Parameters

$recurring_id

int

Id of the recurring

$line_id

int

Id of the line to delete

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring lines update

recurringLinesUpdate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring list

recurringList($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Public recurring update

recurringUpdate($params) : \Zend_Rest_Client_Result

params	araray $params Params of request

Parameters

$params

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Set local HTTP client as distinct from the static HTTP client as inherited from Zend_Rest_Client.

setLocalHttpClient(\Zend_Http_Client $client) : \OSS_Service_Freshbooks

Parameters

$client

\Zend_Http_Client

Returns

\OSS_Service_Freshbooks

Set username

setSubdomain(string $value) : \OSS_Service_Freshbooks

Parameters

$value

string

Returns

\OSS_Service_Freshbooks

Public system current

systemCurrent() : \Zend_Rest_Client_Result

Exceptions

`\Zend_Http_Client_Exception`	if HTTP request fails or times out

Returns

\Zend_Rest_Client_Result

Performs an HTTP GET request to the $path.

_get(string $path, array $query) : \Zend_Http_Response

Parameters

$path

string

$query

array

Array of GET parameters

Exceptions

`\Zend_Http_Client_Exception`

Returns

\Zend_Http_Response

Initialize HTTP authentication

_init() : void

Exceptions

`\Zend_Service_Exception`	if not authorised

Makes addres string xml from address array

_makeAddressXml(array $address, string $type) : string

Parameters

$address

array

The address data.

$type

string

The type of address( primary(p | secondary (s) )

Returns

string

Makes client string xml from params

_makeClientXml(array $params) : string

Parameters

$params

array

The client params.

Returns

string

Makes contacts string xml from contacts array

_makeContactsXml(array $contacts) : string

Parameters

$contacts

array

The contacts data.

Returns

string

Makes invoice string xml from params

_makeInvoiceXml(array $params) : string

Parameters

$params

array

The invoice params.

Returns

string

Makes lines string xml from lines array

_makeLinesXml(array $lines) : string

Parameters

$lines

array

The lines data.

Returns

string

Makes recurring string xml from params

_makeRecurringXml(array $params) : string

Parameters

$params

array

The recurring params.

Returns

string

Perform a POST or PUT

_performPost(mixed $method, mixed $data) : \Zend_Http_Response

Performs a POST or PUT request. Any data provided is set in the HTTP client. String data is pushed in as raw POST data; array or object data is pushed in as POST parameters.

Parameters

$method

mixed

$data

mixed

Returns

\Zend_Http_Response

Performs an HTTP POST request to $path.

_post(string $path, mixed $data) : \Zend_Http_Response

Parameters

$path

string

$data

mixed

Raw data to send

Exceptions

`\Zend_Http_Client_Exception`

Returns

\Zend_Http_Response

Call a remote REST web service URI and return the Zend_Http_Response object

_prepare(string $path) : void

Parameters

$path

string

The path to append to the URI

Exceptions

`\Zend_Rest_Client_Exception`

Set date header

_setDate(int | string $value) : void

Parameters

$value

intstring

Properties

Cookie jar

$_cookieJar : \Zend_Http_CookieJar

Date format for 'since' strings

$_dateFormat : string

Local HTTP Client cloned from statically set client

$_localHttpClient : \Zend_Http_Client

Current method type (for method proxying)

$_methodType : string

Types of API methods

$_methodTypes : array

Zend_Oauth Consumer

$_oauthConsumer : \Zend_Oauth_Consumer

Options passed to constructor

$_options : array

Subomain

$_subdomain : string