\OllTv
Oll.tv ispAPI class
- Author: Prakapas Andriy <prakapas@general-servers.com>
- Copyright: 2016 GeneralServers LLC
- License: http://www.apache.org/licenses/LICENSE-2.0
Synopsis
class OllTv
{
- // constants
- const OTV_URL = 'http://oll.tv/';
- const OTV_URL_DEV = 'http://dev.oll.tv/';
- const OTV_URL_API = 'ispAPI';
- const OTV_URL_AUTH = 'auth2';
- const ERROR = 1;
- const WARNING = 2;
- const INFO = 3;
- // members
- protected $_login;
- protected $_password;
- protected $_hash;
- protected $_result;
- protected $_url;
- protected $_log;
- protected integer $_logLevel = 1;
- protected array $_logType = ;
- protected array $_errors = ;
- protected array $_lastMessage = ;
- // methods
- protected boolean _setLastMessage()
- protected boolean _toLog()
- protected array _prepareAccountDefaultData()
- protected string|false _preparePurchaseType()
- protected string|false _prepareDeviceType()
- protected boolean _readResult()
- protected object|false _return()
- protected boolean _createUrl()
- protected boolean _auth()
- protected object|false _sendToAPI()
- public void __construct()
- public string|false getLastMessage()
- public integer|false emailExists()
- public mixed accountExists()
- public string|false addUser()
- public array getUserList()
- public integer|false changeAccount()
- public integer|false deleteAccount()
- public integer|false changeEmail()
- public object|false getUserInfo()
- public integer|false changeUserInfo()
- public integer|false resetParentControl()
- public integer|false enableBundle()
- public integer|false disableBundle()
- public integer|false checkBundle()
- public integer|false changeBundle()
- public object|false getAllPurchases()
- public integer|false addDevice()
- public mixed delDevice()
- public mixed deviceExists()
- public array|false getDeviceList()
Constants
Name | Value |
---|---|
OTV_URL | 'http://oll.tv/' |
OTV_URL_DEV | 'http://dev.oll.tv/' |
OTV_URL_API | 'ispAPI' |
OTV_URL_AUTH | 'auth2' |
ERROR | 1 |
WARNING | 2 |
INFO | 3 |
Members
protected
- $_errors
—
array
ispAPI errors array: key - error status value has short message and full description - $_hash
—
string
ispAPI hash Hash return ispAPI; using in all requests - $_lastMessage
—
array
Last message array You can get last message by type even when log has disabled - $_log
—
string
Path to log file - $_logLevel
—
integer
Log level variable 0 - not show any messages 1 - only Errors - DEFAULT 2 - Errors, Warnings 3 - Errors, Warnings and Informations - $_logType
—
array
Log message type Related with $_logLevel var - $_login
—
string
Client ispAPI login Assign in constructor - $_password
—
string
Client ispAPI password Assign in constructor - $_result
—
string
Result variable Return ispAPI - $_url
—
string
ispAPI url
Methods
protected
- _auth() — Authenticate to ispAPI and assign hash
- _createUrl() — Create ispAPI url
- _prepareAccountDefaultData() — Method prepare default account data
- _prepareDeviceType() — Method prepare device type
- _preparePurchaseType() — Method prepare purchase type
- _readResult() — Read result from ispAPI
- _return() — Return ispAPI result
- _sendToAPI() — Method send ispAPI action by CURL
- _setLastMessage() — Assign last message
- _toLog() — Write to log file
public
- __construct() — Constructor
- accountExists() — Return account object
- addDevice() — Add device and bind to user $account is required $serialNumber or $mac is required, but advisable required TWO $binding_code is required for providers that work with purchases for access to additional devices $addParams may assigns 'device_type', 'device_model', 'type'
- addUser() — Add new user
- changeAccount() — Assign provider account and bind user to account
- changeBundle() — Change use bundle-subscription
- changeEmail() — Change user email
- changeUserInfo() — Return user information
- checkBundle() — Check user bundle
- delDevice() — Unbind device from user $serialNumber or $mac is required, but advisable required TWO $account is NOT required $type may assigns: device_break_contract - end of contract device_change - equipment problem
- deleteAccount() — Unbind user from provider by params
- deviceExists() — Check device $serialNumber or $mac is required, but advisable required TWO
- disableBundle() — Disable bundle
- emailExists() — Verify user email
- enableBundle() — Enable bundle
- getAllPurchases() — Get active provider's purchases
- getDeviceList() — Return device list
- getLastMessage() — Return last message
- getUserInfo() — Return user information
- getUserList() — Return user list bound to provider
- resetParentControl() — Reset parent control