vB_Api_Cron
extends vB_Api
in package
vB_Api_Cron
Tags
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.
- delete() : standard
- Delete a cron
- fetchAll() : array<string|int, mixed>
- Fetches All cron tasks
- fetchById() : array<string|int, mixed>
- Fetch a cron by its ID
- fetchByVarname() : array<string|int, mixed>
- Returns a cron task based on the cron varname
- fetchLog() : array<string|int, mixed>
- Fetch cron log
- getApiClassName() : 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.
- nextRun() : int
- Returns the cron next run time.
- pruneLog() : void
- Prune Cron
- run() : bool
- Run cron
- runById() : mixed
- Run a cron
- runByVarname() : mixed
- Run a cron
- runCron() : mixed
- runEventQueue() : mixed
- save() : int
- Insert a new cron or Update an existing cron
- shouldTriggerCron() : mixed
- switchActive() : void
- Toggle the enable/disable status of a cron
- updateEnabled() : standard
- Update enable status of crons
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.
delete()
Delete a cron
public
delete(int $cronid) : standard
Parameters
- $cronid : int
-
Cron ID to be deleted
Return values
standard —success array
fetchAll()
Fetches All cron tasks
public
fetchAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —Crons
fetchById()
Fetch a cron by its ID
public
fetchById(int $cronid) : array<string|int, mixed>
Parameters
- $cronid : int
Return values
array<string|int, mixed> —Cron information
fetchByVarname()
Returns a cron task based on the cron varname
public
fetchByVarname(mixed $varname) : array<string|int, mixed>
Parameters
- $varname : mixed
Return values
array<string|int, mixed> —Cron info
fetchLog()
Fetch cron log
public
fetchLog([mixed $varname = '' ][, mixed $orderby = '' ][, mixed $page = 1 ][, mixed $perpage = 15 ]) : array<string|int, mixed>
Parameters
- $varname : mixed = ''
- $orderby : mixed = ''
- $page : mixed = 1
- $perpage : mixed = 15
Return values
array<string|int, mixed> —Cron log information
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : 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
nextRun()
Returns the cron next run time.
public
nextRun() : int
Return values
int —Cron next run timestamp.
pruneLog()
Prune Cron
public
pruneLog([mixed $varname = '' ][, mixed $daysprune = 30 ]) : void
Parameters
- $varname : mixed = ''
- $daysprune : mixed = 30
run()
Run cron
public
run() : bool
Tags
Return values
boolrunById()
Run a cron
public
runById(int $cronid) : mixed
Runs the specified cron immediately without regard for it's usual scheduling
Parameters
- $cronid : int
runByVarname()
Run a cron
public
runByVarname(string $varname) : mixed
Runs the specified cron immediately without regard for it's usual scheduling
Parameters
- $varname : string
-
-- the string identifier for the cron
runCron()
public
runCron() : mixed
runEventQueue()
public
runEventQueue() : mixed
save()
Insert a new cron or Update an existing cron
public
save(array<string|int, mixed> $data[, int $cronid = 0 ]) : int
Parameters
- $data : array<string|int, mixed>
-
Cron data to be inserted or updated 'varname' => Varname 'filename' => Filename 'title' => Title 'description' => Description 'logphrase' => Log Phrase 'weekday' => Day of the Week (Note: this overrides the 'day of the month' option) 'day' => Day of the Month 'hour' => Hour 'minute' => Minute 'active' => Active. Boolean. 'loglevel' => Log Entries. Boolean. 'product' => Product 'volatile' => vBulletin Default. Boolean.
- $cronid : int = 0
-
If not 0, it's the cron ID to be updated
Return values
int —New cron ID or updated Cron's ID
shouldTriggerCron()
public
shouldTriggerCron() : mixed
switchActive()
Toggle the enable/disable status of a cron
public
switchActive(int $cronid) : void
Parameters
- $cronid : int
-
Cron ID
updateEnabled()
Update enable status of crons
public
updateEnabled(array<string|int, mixed> $crons) : standard
Parameters
- $crons : array<string|int, mixed>
-
An array with cronid as key and status as value
Return values
standard —success array