class vB_Api_Cron extends vB_Api

vB_Api_Cron

Traits

Properties

protected bool $disabled Indicates whether the API was disabled from vB_Api
protected array $disableWhiteList
protected array $disableFalseReturnOnly Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others. from vB_Api
protected string $controller API Controller from vB_Api
protected vB_Database $db Database object. from vB_Api

Methods

__sleep()

No description

__wakeup()

No description

static 
getApiClassName($controller)

No description

from vB_Api
static 
getApiClassNameInternal($controller)

No description

from vB_Api
static 
getApiClass($controller, $errorCheck = true)

No description

from vB_Api
static vB_Api
instanceInternal(string $controller, bool $refresh_cache = false)

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

from vB_Api
static vB_Api
instance(string $controller, bool $refresh_cache = false)

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

from vB_Api
static 
clearCache()

Clears all previously loaded API objects.

from vB_Api
The
callNamed()

Call the given api function by name with a named arguments list.

from vB_Api
static string
map_vb4_input_to_vb5(string $method, array $request)

Returns vb5 api method name.

from vB_Api
static 
map_vb5_output_to_vb4(string $method, array $data)

Alters the output array in any way necessary to interface correctly with vb4.

from vB_Api
static 
map_vb5_errors_to_vb4(string $method, array $data)

Alters the error array in any way necessary to interface correctly with vb4.

from vB_Api
__construct()

No description

from vB_Api
checkApiState($method)

This method checks whether the API method is enabled.

from vB_Api
bool
isWhiteListed(string $method)

Checks if method is white listed when API is disabled.

from vB_Api
bool
isDisableFalseReturnOnly(string $method)

Checks if method returns false response only when API is disabled.

from vB_Api
toSeoFriendly(string $str)

Replaces special characters in a given string with dashes to make the string SEO friendly

from vB_Api
none
checkHasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission, and if not throws an exception

from vB_Api
boolean
hasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission

from vB_Api
checkIsLoggedIn()

Determines if the calling user has the given admin permission, and if not throws an exception

from vB_Api
setController(string $controller)

Set controller

from vB_Api
inDebugMode()

No description

from vB_Api
bool
run()

Run cron

void
runOne(int $cronid = 0, string $varname = '')

Run a cron by its ID or varname

array
fetchById(int $cronid)

Fetch a cron by its ID

int
nextRun()

Returns the cron next run time.

array
fetchByVarName(string $varName)

Returns a cron task based on the cron varname

array
fetchAll()

Fetches All cron tasks

int
save(array $data, int $cronid = 0)

Insert a new cron or Update an existing cron

standard
updateEnabled(array $crons)

Update enable status of crons

standard
delete(int $cronid)

Delete a cron

void
switchActive(int $cronid)

Toggle the enable/disable status of a cron

array
fetchLog(string $varname = '', string $orderby = '', int $page = 1, int $perpage = 15)

Fetch cron log

void
pruneLog(string $varname = '', int $daysprune = 30)

Prune Cron

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Api at line 63
static getApiClassName($controller)

Parameters

$controller

in vB_Api at line 69
static protected getApiClassNameInternal($controller)

Parameters

$controller

in vB_Api at line 97
static protected getApiClass($controller, $errorCheck = true)

Parameters

$controller
$errorCheck

in vB_Api at line 177
static vB_Api instanceInternal(string $controller, bool $refresh_cache = false)

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

Parameters

string $controller -- name of the API controller to load
bool $refresh_cache -- true if we want to force the cache to update with a new api object primarily intended for testing

Return Value

vB_Api

in vB_Api at line 203
static vB_Api instance(string $controller, bool $refresh_cache = false)

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

Parameters

string $controller -- name of the API controller to load
bool $refresh_cache -- true if we want to force the cache to update with a new api object primarily intended for testing

Return Value

vB_Api

in vB_Api at line 237
static clearCache()

Clears all previously loaded API objects.

Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.

in vB_Api at line 259
The callNamed()

Call the given api function by name with a named arguments list.

Used primarily to translate REST requests into API calls.

Return Value

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.

in vB_Api at line 313
static string map_vb4_input_to_vb5(string $method, array $request)

Returns vb5 api method name.

May alter request array.

Parameters

string $method -- vb4 method name
array $request -- $_REQUEST array for this api request

Return Value

string

in vB_Api at line 497
static map_vb5_output_to_vb4(string $method, array $data)

Alters the output array in any way necessary to interface correctly with vb4.

Parameters

string $method -- vb4 method name
array $data -- output array from vb5

in vB_Api at line 545
static map_vb5_errors_to_vb4(string $method, array $data)

Alters the error array in any way necessary to interface correctly with vb4.

Parameters

string $method -- vb4 method name
array $data -- error array from vb5

in vB_Api at line 609
protected __construct()

in vB_Api at line 631
checkApiState($method)

This method checks whether the API method is enabled.

For extensions check make sure $controller property is already set.

Parameters

$method

in vB_Api at line 657
protected bool isWhiteListed(string $method)

Checks if method is white listed when API is disabled.

Parameters

string $method API method to check.

Return Value

bool Indicates whether method is or is not a white list.

in vB_Api at line 685
protected bool isDisableFalseReturnOnly(string $method)

Checks if method returns false response only when API is disabled.

Parameters

string $method API method to check.

Return Value

bool Indicates whether method returns false response only.

in vB_Api at line 712
protected toSeoFriendly(string $str)

Replaces special characters in a given string with dashes to make the string SEO friendly

Parameters

string $str The string to be converted

in vB_Api at line 734
protected none checkHasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission, and if not throws an exception

Checks for: * A valid CP Session * The passed adminpermission.

Parameters

string $adminPermission The admin permission to check

Return Value

none

Exceptions

inlinemodauth_required -- The current session is not a mod/admin session
nopermission_loggedin -- The user does not have the given permission
no_permission -- The user is not logged in at all.

in vB_Api at line 753
protected boolean hasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission

Useful if you need to know if the calling user but do not care why they do not have that permission. Generally useful if there is a behavior difference between admins and non admins, but the call can be processed for either.

Parameters

string $adminPermission The admin permission to check

Return Value

boolean true if checks pass, false otherwise

in vB_Api at line 807
protected checkIsLoggedIn()

Determines if the calling user has the given admin permission, and if not throws an exception

in vB_Api at line 821
protected setController(string $controller)

Set controller

Parameters

string $controller Controller name

in vB_Api at line 831
protected inDebugMode()

at line 31
bool run()

Run cron

Return Value

bool

at line 46
void runOne(int $cronid = 0, string $varname = '')

Run a cron by its ID or varname

Parameters

int $cronid Cron Id
string $varname Varname

Return Value

void

at line 93
array fetchById(int $cronid)

Fetch a cron by its ID

Parameters

int $cronid

Return Value

array Cron information

at line 110
int nextRun()

Returns the cron next run time.

Return Value

int Cron next run timestamp.

at line 179
array fetchByVarName(string $varName)

Returns a cron task based on the cron varname

Parameters

string $varName Cron varname

Return Value

array Cron info

at line 196
array fetchAll()

Fetches All cron tasks

Return Value

array Crons

at line 224
int save(array $data, int $cronid = 0)

Insert a new cron or Update an existing cron

Parameters

array $data 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.
int $cronid If not 0, it's the cron ID to be updated

Return Value

int New cron ID or updated Cron's ID

at line 404
standard updateEnabled(array $crons)

Update enable status of crons

Parameters

array $crons An array with cronid as key and status as value

Return Value

standard success array

at line 442
standard delete(int $cronid)

Delete a cron

Parameters

int $cronid Cron ID to be deleted

Return Value

standard success array

at line 478
void switchActive(int $cronid)

Toggle the enable/disable status of a cron

Parameters

int $cronid Cron ID

Return Value

void

at line 517
array fetchLog(string $varname = '', string $orderby = '', int $page = 1, int $perpage = 15)

Fetch cron log

Parameters

string $varname Show Only Entries Generated By the cron with this varname. '0' means show all crons' log.
string $orderby Cron log show order
int $page Page of the cron log list
int $perpage Number of entries to show per page

Return Value

array Cron log information

at line 553
void pruneLog(string $varname = '', int $daysprune = 30)

Prune Cron

Parameters

string $varname Remove Entries Relating to Action.
int $daysprune Remove Entries Older Than (Days)

Return Value

void