vBulletin v6.0.4

vB_Api_Ad extends vB_Api
in package

vB_Api_Ad Advertising API

Tags
access

public

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()  : bool
Deletes an ad
fetch()  : array<string|int, mixed>
Fetches an ad by its ID
fetchDisplayOptions()  : array<string|int, mixed>
Fetches display options
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
listAdsByLocation()  : array<string|int, mixed>
Lists ads for a location
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.
quickSave()  : bool
Saves the active status and display orders for multiple ads
save()  : int
Updates an existing ad or saves a new ad
saveNumberOfHeaderAds()  : bool
Saves the number of header ads to use (this can be 1 or 2)

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>

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

Deletes an ad

public delete(int $adid) : bool
Parameters
$adid : int

Ad ID to delete

Return values
bool —

Returns true on success

fetch()

Fetches an ad by its ID

public fetch(int $adid) : array<string|int, mixed>
Parameters
$adid : int

Ad ID

Tags
throws
vB_Exception_Api

invalidid if the specified ad id does not exist

Return values
array<string|int, mixed> —

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

fetchDisplayOptions()

Fetches display options

public fetchDisplayOptions([int $adid = 0 ]) : array<string|int, mixed>
Parameters
$adid : int = 0

(optinal) Ad ID

Return values
array<string|int, mixed> —

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

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_Api

instanceInternal()

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_Api

listAdsByLocation()

Lists ads for a location

public listAdsByLocation(string $adlocation) : array<string|int, mixed>
Parameters
$adlocation : string

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

Return values
array<string|int, mixed> —

Returns an array of ads (fields from the ad and adcriteria tables)

map_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
string

map_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

quickSave()

Saves the active status and display orders for multiple ads

public quickSave(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

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

Return values
bool —

True on success

save()

Updates an existing ad or saves a new ad

public save(int $adid, array<string|int, mixed> $data) : int
Parameters
$adid : int

ID of Ad to be updated. Set to 0 to insert a new Ad

$data : array<string|int, mixed>

Ad data

Tags
throws
vB_Exception_Api

invalid_title_specified if the title is missing

Return values
int —

Ad ID

saveNumberOfHeaderAds()

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

public saveNumberOfHeaderAds(int $number) : bool
Parameters
$number : int

Number of header ads to show (1 or 2)

Return values
bool —

True on success


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results