API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformGallery

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
$list_office_aor
$listing_id
$listing_images
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$list_office_aor

$list_office_aor : string

Type

string — MLS the listing is listed with

$listing_id

$listing_id : string

Type

string — mls number for the listing

$listing_images

$listing_images : array

Type

array — of image arrays associated with the property in the format [ "thumb_url" => "(string) url to thumbnail size image -- smallest", "small_url" => "(string) url to small size image -- small", "full_url" => "(string) url to medium size image -- medium", "gallery_url" => "(string) url to large size image -- large", "raw_url" => "(string) url to largest size image -- largest" "title" => (String) human readable title of image "is_main_listing_image" => (Boolean) whether the image is the main image for the listing "caption" => (String) human readable caption for the image "description" => (String) human readable description of the image "width" => (Integer) width of the raw image "height" => (Integer) height of the raw image "mime_type" => (String) MIME or media type of the image ]

Methods

headers()

headers()

authHeader()

authHeader()

acceptHeader()

acceptHeader()

contentTypeHeader()

contentTypeHeader()

userAgentHeader()

userAgentHeader()

apiConnection()

apiConnection(  $method,   $url,   $attributes)

Parameters

$method
$url
$attributes

checkForErrorInResponse()

checkForErrorInResponse(  $json)

Parameters

$json

underscore()

underscore(  $attr)

Parameters

$attr

__construct()

__construct(array  $data)

Gallery constructor.

Parameters

array $data

find()

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

Find an Gallery on Moxi Works Platform.

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

Parameters

array $attributes


moxi_works_agent_id REQUIRED The Moxi Works Gallery ID for the gallery
agent_uuid REQUIRED The Moxi Works Gallery ID for the gallery

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Gallery|null

sendRequest()

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

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Gallery|null