vBulletin v6.0.4

vB_Api_Eventhighlight extends vB_Api
in package

vB_Api_Eventhighlight

Tags
access

public

Table of Contents

Methods

__construct()  : mixed
Constructor
__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.
deleteEventHighlight()  : array<string|int, mixed>
Deletes an event highlight
getApiClassName()  : mixed
getEventHighlightAdmin()  : array<string|int, mixed>
Returns the specified event highlight for administration purposes.
getEventHighlightsAdmin()  : array<string|int, mixed>
Returns the full listing of event highlights for administration purposes.
getEventHighlightsUser()  : array<string|int, mixed>
Returns the listing of event highlights for the currently logged in user
getEventHighlightViewInfo()  : array<string|int, mixed>
Returns the view information to display all event highlights
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.
saveEventHighlight()  : array<string|int, mixed>
Saves (creates or updates) an event highlight
saveEventHighlightDisplayOrder()  : array<string|int, mixed>
Saves event highlight display order for multiple event highlights
saveEventHighlightPermissions()  : array<string|int, mixed>
Saves event highlight permissions for one event highlight

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.

deleteEventHighlight()

Deletes an event highlight

public deleteEventHighlight(mixed $eventhighlightid) : array<string|int, mixed>
Parameters
$eventhighlightid : mixed
Return values
array<string|int, mixed> —

Success array

getApiClassName()

public static getApiClassName(mixed $controller) : mixed
Parameters
$controller : mixed

getEventHighlightAdmin()

Returns the specified event highlight for administration purposes.

public getEventHighlightAdmin(mixed $eventhighlightid[, mixed $withPermissions = false ]) : array<string|int, mixed>
Parameters
$eventhighlightid : mixed
$withPermissions : mixed = false
Return values
array<string|int, mixed> —

Event highlight information

getEventHighlightsAdmin()

Returns the full listing of event highlights for administration purposes.

public getEventHighlightsAdmin([mixed $eventhighlightids = array() ][, mixed $withPermissions = false ]) : array<string|int, mixed>
Parameters
$eventhighlightids : mixed = array()
$withPermissions : mixed = false
Return values
array<string|int, mixed> —

Full listing of event highlights

getEventHighlightsUser()

Returns the listing of event highlights for the currently logged in user

public getEventHighlightsUser() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Listing of available event highlights

getEventHighlightViewInfo()

Returns the view information to display all event highlights

public getEventHighlightViewInfo() : array<string|int, mixed>
Return values
array<string|int, mixed> —

View information for all event highlights (permissions only affect being able to apply an event highlight to a node)

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

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

saveEventHighlight()

Saves (creates or updates) an event highlight

public saveEventHighlight(mixed $data) : array<string|int, mixed>
Parameters
$data : mixed
Return values
array<string|int, mixed> —

Event highlight information

saveEventHighlightDisplayOrder()

Saves event highlight display order for multiple event highlights

public saveEventHighlightDisplayOrder(mixed $displayOrder) : array<string|int, mixed>
Parameters
$displayOrder : mixed
Return values
array<string|int, mixed> —

Success array

saveEventHighlightPermissions()

Saves event highlight permissions for one event highlight

public saveEventHighlightPermissions(mixed $eventhighlightid, mixed $denybydefault, mixed $denyusergroups) : array<string|int, mixed>
Parameters
$eventhighlightid : mixed
$denybydefault : mixed
$denyusergroups : mixed
Return values
array<string|int, mixed> —

Success array


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results