vBulletin v6.0.4

vB_Api_Page extends vB_Api
in package

vB_Api_Page

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.
checkCustomUrl()  : bool
This is used for setting a custom url to make sure that the new url is valid as a prefix
clearCache()  : mixed
Clears all previously loaded API objects.
delete()  : array<string|int, mixed>
Deletes a page
deleteOrphanedPagetemplates()  : mixed
fetchPageById()  : array<string|int, mixed>
Get information for a page
fetchRouteClass()  : mixed
Returns the pagetemplate record given a pageid
fetchScreenLayoutList()  : array<string|int, mixed>
Returns a list of all "selectable" screen layouts. Currently excludes the "bare full" layout, which is used specifically for the PM Chat window.
getApiClassName()  : mixed
getHomePages()  : mixed
Returns a list of pages to show as the home page options in quick config
getOrphanedPagetemplates()  : mixed
getPageNav()  : mixed
getPagingInfo()  : array<string|int, mixed>
Get pagination information for frontend use
getQryCount()  : array<string|int, mixed>
This returns the number and type of database asserts. This is similar to but a bit smaller than the number of queries executed.
getURLs()  : array<string|int, mixed>
Get URLs for use in sitebuilder's page manager, navigation bar & footer.
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
isGlobalDisplaySection()  : bool
Determines if the section is a global display section (displays on all pages)
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.
pageSave()  : array<string|int, mixed>
Saves a page based on page editor info
preload()  : mixed
This preloads information for the current page.
savePreCacheInfo()  : mixed
This saves preload information for the current page.
setAsHomePage()  : mixed

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

checkCustomUrl()

This is used for setting a custom url to make sure that the new url is valid as a prefix

public checkCustomUrl(string $prefixCandidate) : bool
Parameters
$prefixCandidate : string

-- the 'resturl' to be checked

Return values
bool —

-- true if no reserved characters are used in the url AND it is unique

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 a page

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

success=>true or success=>false and an error array

deleteOrphanedPagetemplates()

public deleteOrphanedPagetemplates(mixed $pagetemplateids) : mixed
Parameters
$pagetemplateids : mixed

fetchPageById()

Get information for a page

public fetchPageById(int $pageid[, array<string|int, mixed> $routeData = [] ]) : array<string|int, mixed>
Parameters
$pageid : int
$routeData : array<string|int, mixed> = []

-- The needed to render this pages route. Will vary by page

Return values
array<string|int, mixed> —

pageid int parentid int -- the parent page (currently unused) pagetemplateid int title string metadescription string -- the metadescription to display when page is rendered as html routeid int -- route associated with this page moderatorid int -- need to determine displayorder int -- the order to display page when displaying lists of pages pagetype string -- default or custom depending of if this is a page we install with the system product string -- product the page belongs to 'vbulletin' for pages created by the system and via the admincp guid string -- globally unique identifier screenlayoutid int -- layout for the page screenlayouttemplate string -- name of the layout template templatetitle string -- need to determine isgeneric boolean -- DEPRECATED true if this is of type default urlprefix string -- prefix for the route url string -- url generated from the route -- will be relative to the frontend base urlscheme string -- DEPRECATED -- will be blank urlhostname string -- DEPRECATED -- will be blank noindex boolean -- should this page be indexed. nofollow boolean -- should this page be followed.

fetchRouteClass()

Returns the pagetemplate record given a pageid

public fetchRouteClass(int $pageid) : mixed
Parameters
$pageid : int
Return values
mixed —

array with success=>true/false and usually an error array or a route class.

fetchScreenLayoutList()

Returns a list of all "selectable" screen layouts. Currently excludes the "bare full" layout, which is used specifically for the PM Chat window.

public fetchScreenLayoutList([mixed $skipcache = false ]) : array<string|int, mixed>
Parameters
$skipcache : mixed = false
Return values
array<string|int, mixed>

getApiClassName()

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

getHomePages()

Returns a list of pages to show as the home page options in quick config

public getHomePages() : mixed

getOrphanedPagetemplates()

public getOrphanedPagetemplates([mixed $params = [] ]) : mixed
Parameters
$params : mixed = []

getPageNav()

public getPageNav([mixed $currentpage = 1 ][, mixed $totalpages = 1 ]) : mixed
Parameters
$currentpage : mixed = 1
$totalpages : mixed = 1

getPagingInfo()

Get pagination information for frontend use

public getPagingInfo([mixed $pageNum = 1 ][, mixed $totalCount = 0 ][, mixed $perPage = 0 ][, array<string|int, mixed> $routeInfo = [] ][, mixed $baseUrl = '' ][, mixed $maxpage = 0 ]) : array<string|int, mixed>
Parameters
$pageNum : mixed = 1
$totalCount : mixed = 0
$perPage : mixed = 0
$routeInfo : array<string|int, mixed> = []
$baseUrl : mixed = ''
$maxpage : mixed = 0
Return values
array<string|int, mixed> —

Number of pages, start/end count, next/previous URLs

getQryCount()

This returns the number and type of database asserts. This is similar to but a bit smaller than the number of queries executed.

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

queryCount int queries array -- query strings

getURLs()

Get URLs for use in sitebuilder's page manager, navigation bar & footer.

public getURLs([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []

'type' => string all|system|custom|channels|home - shorthand for includes/excludes combinations to return a subset of URLs. Warning, 'type' will OVERRIDE 'include' & 'exclude'! 'include' => array of all|system|custom|channels|home 'exclude' => array of system|custom|channels 'unpaginated' => include unpaginated list in the 'all' return array

Return values
array<string|int, mixed> —

Data highly customized for use in sitebuilder 'all' 'pagenav' - pagenav info for 'paginated' below 'paginated' - paginated nested list of page data 'unpaginated' - only set if $params['unpaginated'] is passed in. flat list of page data 'orphans' - list of orphaned pagetemplates

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

isGlobalDisplaySection()

Determines if the section is a global display section (displays on all pages)

public isGlobalDisplaySection(mixed $section) : bool
Parameters
$section : mixed
Return values
bool —

True if it is a global display section, otherwise false

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

pageSave()

Saves a page based on page editor info

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

success boolean url string -- DEPRECATED this will not always be correct due to the lack of complete route data. See the action savePage in the front end controller for a way to generate the correct url for the updated page pageid int -- the pageid for the update or created page

preload()

This preloads information for the current page.

public preload(mixed $pageKey) : mixed
Parameters
$pageKey : mixed

savePreCacheInfo()

This saves preload information for the current page.

public savePreCacheInfo(string $pageKey) : mixed
Parameters
$pageKey : string

-- the identifier for this page, which comes from the route class.

setAsHomePage()

public setAsHomePage(mixed $pageid) : mixed
Parameters
$pageid : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results