MyAllocator PMS PHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • MyAllocator
    • phpsdk
      • src
        • Api
        • Exception
        • Object
        • Util
  • PHP

Classes

  • Auth

Class Auth

The authentication class used to store authentication parameters to be used in one or more API requests.

Namespace: MyAllocator\phpsdk\src\Object
Located at Object/Auth.php

Methods summary

public mixed
# getAuthKeyVar( string $key )

Map an API authentication key to the Auth object's variable and return it.

Map an API authentication key to the Auth object's variable and return it.

Parameters

$key
The API authentication key.

Returns

mixed
The requested API variable.

Throws

MyAllocator\phpsdk\src\Exception\ApiException
public string
# getAuthKeyByVar( string $property )

Get an authentication key by variable name.

Get an authentication key by variable name.

Parameters

$property
The property/variable name.

Returns

string
The authentication key.

Throws

MyAllocator\phpsdk\src\Exception\ApiException

Magic methods summary

Properties summary

public string $vendorId

The vendor id (Required without user credentials).

The vendor id (Required without user credentials).

# null
public string $vendorPassword

The vendor password (Required without user credentials).

The vendor password (Required without user credentials).

# null
public string $userId

The user id (Required without vendor credentials).

The user id (Required without vendor credentials).

# null
public string $PMSUserId

The system user id.

The system user id.

# null
public string $userPassword

The user password (Required without vendor credentials).

The user password (Required without vendor credentials).

# null
public string $userToken

The user token (can store/use instead of username/password).

The user token (can store/use instead of username/password).

# null
public string $propertyId

The MyAllocator property id.

The MyAllocator property id.

# null
public string $PMSPropertyId

The system property id.

The system property id.

# null
MyAllocator PMS PHP SDK API documentation generated by ApiGen