\MoxiworksPlatformCompany

Summary

Methods
Properties
Constants
__construct()
find()
search()
$moxi_works_company_id
$name
$partners
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$moxi_works_company_id

$moxi_works_company_id : string

Type

string — the Moxi Works Platform ID of the company

$name

$name : string

Type

string — the human readable name of the company

$partners

$partners : Array

Type

Array — partner data associated with the company

Methods

__construct()

__construct(array  $data) 

Company constructor.

Parameters

array $data

find()

find(array  $attributes = array()) : \MoxiworksPlatform\Company|null

Find a Company on Moxi Works Platform.

find can be performed including the Moxi Works Company ID in a parameter array \MoxiworksPlatform\Company::find([moxi_works_company_id: 'abc123'])

Parameters

array $attributes


moxi_works_company_id REQUIRED The Moxi Works Company ID

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Company|null

search()

search(  $attributes = array()) : Array

Search for Companies on Moxi Works Platform.

\MoxiworksPlatform\Company::search()

Parameters

$attributes

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\Exception\ArgumentException

if at least one search parameter is not defined

\MoxiworksPlatform\RemoteRequestFailureException

Returns

Array —

of Group objects

sendRequest()

sendRequest(  $method, array  $opts = array(), null  $url = null) : \MoxiworksPlatform\Company|null

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Company|null