vB_Api_Styleschedule
extends vB_Api
in package
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- callNamed() : The
- Call the given api function by name with a named arguments list.
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- deleteSchedule() : array<string|int, mixed>
- getAllSchedules() : array<string|int, mixed>
- getApiClassName() : mixed
- getSchedule() : array<string|int, mixed>
- instance() : vB_Api
- Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
- instanceInternal() : vB_Api
- Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
- map_vb4_input_to_vb5() : string
- Returns vb5 api method name.
- map_vb5_errors_to_vb4() : mixed
- Alters the error array in any way necessary to interface correctly with vb4.
- map_vb5_output_to_vb4() : mixed
- Alters the output array in any way necessary to interface correctly with vb4.
- saveSchedule() : array<string|int, mixed>
- Insert a new style schedule or update an existing one.
- saveSchedulesBulk() : array<string|int, mixed>
- Insert a new style schedule or update an existing one.
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
callNamed()
Call the given api function by name with a named arguments list.
public
callNamed() : The
Used primarily to translate REST requests into API calls.
Return values
The —return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.
checkApiState()
This method checks whether the API method is enabled.
public
checkApiState(mixed $method) : mixed
For extensions check make sure $controller property is already set.
Parameters
- $method : mixed
clearCache()
Clears all previously loaded API objects.
public
static clearCache() : mixed
Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.
deleteSchedule()
public
deleteSchedule(int $scheduleid) : array<string|int, mixed>
Parameters
- $scheduleid : int
Return values
array<string|int, mixed>getAllSchedules()
public
getAllSchedules() : array<string|int, mixed>
Return values
array<string|int, mixed>getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
getSchedule()
public
getSchedule(int $scheduleid) : array<string|int, mixed>
Parameters
- $scheduleid : int
Return values
array<string|int, mixed>instance()
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
public
static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_ApiinstanceInternal()
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
public
static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Apimap_vb4_input_to_vb5()
Returns vb5 api method name.
public
static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string
May alter request array.
Parameters
- $method : string
-
-- vb4 method name
- $request : array<string|int, mixed>
-
-- $_REQUEST array for this api request
Return values
stringmap_vb5_errors_to_vb4()
Alters the error array in any way necessary to interface correctly with vb4.
public
static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- error array from vb5
map_vb5_output_to_vb4()
Alters the output array in any way necessary to interface correctly with vb4.
public
static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- output array from vb5
saveSchedule()
Insert a new style schedule or update an existing one.
public
saveSchedule(mixed $data) : array<string|int, mixed>
Parameters
- $data : mixed
-
Style schedule data. Can be either an array or an vB_Entity_Styleschedule instance. If array, must have 'styleid' int 'enabled' bool 'startdate' int 'enddate' int 'useyear' bool 'timezoneoffset' string (e.g. 1, -8, 4.5) 'overridechannelcustom' bool 'overrideusercustom' bool 'title' string and may have 'scheduleid' int if updating an existing style schedule.
Return values
array<string|int, mixed> —[ 'success' => bool, 'scheduleid' => int|bool saved scheduleid OR false on databse errors ]
saveSchedulesBulk()
Insert a new style schedule or update an existing one.
public
saveSchedulesBulk(mixed $schedules) : array<string|int, mixed>
Parameters
- $schedules : mixed
-
Each element must be an array of schedule data or a vB_Entity_Styleschedule. @see vB_Api_StyleSchedule::saveSchedule()
Return values
array<string|int, mixed> —[ 'success' => bool true if all schedules were saved successfully 'scheduleids' => array of int|bool saved scheduleid OR false on databse errors ]