vBulletin v6.0.4

vB_Library_Page extends vB_Library
in package

vB_Library_Page

Tags
access

public

Table of Contents

Constants

MIN_PRECACHELIFE  = 300

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
clearCache()  : mixed
deleteFromPageInfo()  : true|array<string|int, mixed>
Delete a page
getContentInstance()  : mixed
getHomePages()  : mixed
Returns a list of pages to show as the home page options in quick config
getOrphanedPagetemplates()  : mixed
getURLs()  : mixed
instance()  : static
Returns singleton instance of self.
monitorWords()  : mixed
Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.
preload()  : mixed
This preloads information for the current page.
registerPrecacheInfo()  : mixed
This saves preload information for the current page.
savePreCacheInfo()  : mixed
This saves preload information for the current page.

Constants

MIN_PRECACHELIFE

public mixed MIN_PRECACHELIFE = 300

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>

clearCache()

public static clearCache() : mixed

deleteFromPageInfo()

Delete a page

public deleteFromPageInfo(array<string|int, mixed> $page) : true|array<string|int, mixed>
Parameters
$page : array<string|int, mixed>

-- the page info

Return values
true|array<string|int, mixed> —

-- either on sucess true or an error array

getContentInstance()

public static getContentInstance(mixed $contenttypeid) : mixed
Parameters
$contenttypeid : 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 = []

getURLs()

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

instance()

Returns singleton instance of self.

public static instance(mixed $class) : static
Parameters
$class : mixed
Return values
static —
  • Reference to singleton instance of the requested library class

monitorWords()

Checks if the text contains monitored words, and if so, sends notifications to admins and moderators if the setting is on.

public monitorWords(mixed $text, mixed $type, mixed $nodeid[, mixed $userid = null ][, mixed $insertNotifications = true ][, mixed $currentuserid = 0 ]) : mixed
Parameters
$text : mixed
$type : mixed
$nodeid : mixed
$userid : mixed = null
$insertNotifications : mixed = true
$currentuserid : mixed = 0
Tags
deprecated

use the functions from the notification library directly.

preload()

This preloads information for the current page.

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

registerPrecacheInfo()

This saves preload information for the current page.

public registerPrecacheInfo(string $apiClass, mixed $method, mixed $params) : mixed
Parameters
$apiClass : string

-- name of the api class @param string $method -- name of the api method that should be called

$method : mixed
$params : mixed

-- array of method parameters that should be passed

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.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results