Class MaApi

The Base API class.

MyAllocator\phpsdk\src\MaBaseClass

Extended by

MyAllocator\phpsdk\src\Api\MaApi

Direct known subclasses

MyAllocator\phpsdk\src\Api\AmenityList, MyAllocator\phpsdk\src\Api\ARIRulesList, MyAllocator\phpsdk\src\Api\BookingPaymentPasswordValidate, MyAllocator\phpsdk\src\Api\ChannelList, MyAllocator\phpsdk\src\Api\HelloUser, MyAllocator\phpsdk\src\Api\HelloVendor, MyAllocator\phpsdk\src\Api\HelloVendorUser, MyAllocator\phpsdk\src\Api\HelloWorld, MyAllocator\phpsdk\src\Api\LoopARIList, MyAllocator\phpsdk\src\Api\LoopBookingAction, MyAllocator\phpsdk\src\Api\LoopBookingCreate, MyAllocator\phpsdk\src\Api\LoopBookingList, MyAllocator\phpsdk\src\Api\ARIRulesUpdate, MyAllocator\phpsdk\src\Api\NotificationEmailsList, MyAllocator\phpsdk\src\Api\PropertyBillingList, MyAllocator\phpsdk\src\Api\PropertyChannelList, MyAllocator\phpsdk\src\Api\PropertyCreate, MyAllocator\phpsdk\src\Api\PropertyImageCreate, MyAllocator\phpsdk\src\Api\PropertyImageList, MyAllocator\phpsdk\src\Api\PropertyImageRemove, MyAllocator\phpsdk\src\Api\PropertyList, MyAllocator\phpsdk\src\Api\PropertyModify, MyAllocator\phpsdk\src\Api\RoomAvailabilityList, MyAllocator\phpsdk\src\Api\ARIUpdate, MyAllocator\phpsdk\src\Api\RoomCreate, MyAllocator\phpsdk\src\Api\RoomImageCreate, MyAllocator\phpsdk\src\Api\RoomImageList, MyAllocator\phpsdk\src\Api\RoomImageRemove, MyAllocator\phpsdk\src\Api\RoomList, MyAllocator\phpsdk\src\Api\RoomRemove, MyAllocator\phpsdk\src\Api\RoomUpdate, MyAllocator\phpsdk\src\Api\UserCreate, MyAllocator\phpsdk\src\Api\UserExists, MyAllocator\phpsdk\src\Api\VendorSet, MyAllocator\phpsdk\src\Api\ARIUpdateStatus, MyAllocator\phpsdk\src\Api\AssociatePropertyToPMS, MyAllocator\phpsdk\src\Api\AssociateUserToPMS, MyAllocator\phpsdk\src\Api\BookingAction, MyAllocator\phpsdk\src\Api\BookingList, MyAllocator\phpsdk\src\Api\BookingPaymentDownload

Namespace: MyAllocator\phpsdk\src\Api
Located at Api/MaApi.php

Methods summary

`public`	# `__construct( mixed $cfg = null )` Class contructor attempts to assign authentication parameters from $cfg argument. Authentication parameters may be configured via Auth object or array. The parent constructor handles the included configuration parameters. Class contructor attempts to assign authentication parameters from $cfg argument. Authentication parameters may be configured via Auth object or array. The parent constructor handles the included configuration parameters. Parameters `$cfg` <p>API configuration potentially containing an 'auth' key with authentication parameters/object or a 'cfg' key containing configurations to overwrite Config/Config.php.</p> Overrides `MyAllocator\phpsdk\src\MaBaseClass::__construct`
`public`	# `setParams( array $params )` Set the parameters to be used in the API request. Parameters may also be set at the time of API call via callApiWithParams(). Set the parameters to be used in the API request. Parameters may also be set at the time of API call via callApiWithParams(). Parameters `$params` API request parameters.
`public mixed`	# `callApi( )` Call the API using previously set parameters (if any). Call the API using previously set parameters (if any). Returns `mixed` API response.
`public mixed`	# `callApiWithParams( array $params = null )` Call the API using provided parameters (if any). Call the API using provided parameters (if any). Parameters `$params` API request parameters. Returns `mixed` API response.
`public MyAllocator\phpsdk\src\Object\Auth`	# `getAuth( string $errorOnNull = false )` Get the authentication object. Get the authentication object. Parameters `$errorOnNull` If true, throw an exception if auth null. Returns `MyAllocator\phpsdk\src\Object\Auth` API Authentication object. Throws `MyAllocator\phpsdk\src\Exception\ApiException`
`public`	# `setAuth( MyAllocator\phpsdk\src\Object\Auth $auth )` Set the authentication object for the API. Set the authentication object for the API. Parameters `$auth` Authentication object.
`public booleam`	# `isEnabled( )` Determine if the API is enabled. Determine if the API is enabled. Returns `booleam` True if the API is enabled.
`public mixed`	# `getLastApiResponse( )` Get the last API response as array($rbody, $rcode). Get the last API response as array($rbody, $rcode). Returns `mixed` The last API response.

Methods inherited from MyAllocator\phpsdk\src\MaBaseClass

debug(), debug_echo(), debug_print_r(), debug_var_dump(), getConfig(), setConfig()

Magic methods summary

Properties summary

`protected boolean`	`$enabled` Whether or not the API is currently enabled/supported. Whether or not the API is currently enabled/supported.	# `true`
`protected string`	`$id` The api method. The api method.	# `'MaApi'`
`protected array`	`$keys` Array of required and optional authentication and argument keys (string) for API method. Array of required and optional authentication and argument keys (string) for API method.	# `array( 'auth' => array( 'req' => array(), 'opt' => array() ), 'args' => array( 'req' => array(), 'opt' => array() ) )`

Properties inherited from MyAllocator\phpsdk\src\MaBaseClass