class vB_Api_Ad extends vB_Api

vB_Api_Ad Advertising API

Traits

Properties

protected bool $disabled Indicates whether the API was disabled from vB_Api
protected array $disableWhiteList Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others. from vB_Api
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
protected array $ad_cache
protected array $ad_name_cache
protected int $max_displayorder

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()

Constructor

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
updateAdCache()

Populates the ad cache properties $ad_cache and $ad_name_cache

array|bool
listAdsByLocation(string $adlocation)

Lists ads for a location

array
fetch(int $adid)

Fetches an ad by its ID

int
save(int $adid, array $data)

Updates an existing ad or saves a new ad

bool
quickSave(array $data)

Saves the active status and display orders for multiple ads

bool
saveNumberOfHeaderAds(int $number)

Saves the number of header ads to use (this can be 1 or 2)

bool
delete(int $adid)

Deletes an ad

string
buildAdTemplate(string $location)

Builds an ad template based on criteria

array
fetchDisplayOptions(int $adid = 0)

Fetches display options

string
fetchDisplayoptionsHtml(int $adid = 0)

Fetches display options HTML

string
wrapAdTemplate(string $template, string $id_name, string $id_prefix = 'ad_')

Wraps an ad template in a div with the correct id

replaceAdTemplate(string $styleid, string $location, string $template, string $product = 'vbulletin')

Replaces ad code into correct template

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

at line 40
protected __construct()

Constructor

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 51
protected updateAdCache()

Populates the ad cache properties $ad_cache and $ad_name_cache

at line 77
array|bool listAdsByLocation(string $adlocation)

Lists ads for a location

Parameters

string $adlocation The location we want to get ads for (string locations defined in templates)

Return Value

array|bool Returns false if there are no ads, or an array of ads (fields from the ad and adcriteria tables)

at line 108
array fetch(int $adid)

Fetches an ad by its ID

Parameters

int $adid Ad ID

Return Value

array $ad Ad data (fields from the ad and adcriteria tables)

Exceptions

vB_Exception_Api invalidid if the specified ad id does not exist

at line 162
int save(int $adid, array $data)

Updates an existing ad or saves a new ad

Parameters

int $adid ID of Ad to be updated. Set to 0 to insert a new Ad
array $data Ad data

Return Value

int Ad ID

Exceptions

vB_Exception_Api invalid_title_specified if the title is missing

at line 390
bool quickSave(array $data)

Saves the active status and display orders for multiple ads

Parameters

array $data Data to save. Format: array(adid => array('active' => $active, 'displayorder' => $displayorder), ...)

Return Value

bool True on success

at line 447
bool saveNumberOfHeaderAds(int $number)

Saves the number of header ads to use (this can be 1 or 2)

Parameters

int $number Number of header ads to show (1 or 2)

Return Value

bool True on success

at line 474
bool delete(int $adid)

Deletes an ad

Parameters

int $adid Ad ID to delete

Return Value

bool Returns true on success

at line 504
protected string buildAdTemplate(string $location)

Builds an ad template based on criteria

Parameters

string $location Template location

Return Value

string Template string

at line 688
array fetchDisplayOptions(int $adid = 0)

Fetches display options

Parameters

int $adid (optinal) Ad ID

Return Value

array Array with two elements: criteria_options - array with criterion name => criterion info (type, data, default value) criteria_cache - not currently used

at line 862
string fetchDisplayoptionsHtml(int $adid = 0)

Fetches display options HTML

Parameters

int $adid (optional) Ad ID

Return Value

string $output Display Options HTML

at line 1024
protected string wrapAdTemplate(string $template, string $id_name, string $id_prefix = 'ad_')

Wraps an ad template in a div with the correct id

Parameters

string $template Template String
string $id_name Ad location (global_header1)
string $id_prefix ID Prefix (Default: 'ad_')

Return Value

string Wrapped AD Template

at line 1045
protected replaceAdTemplate(string $styleid, string $location, string $template, string $product = 'vbulletin')

Replaces ad code into correct template

Parameters

string $styleid Style for template
string $location Ad location
string $template Template compiled
string $product Product that uses this template