vB_Library_Page
extends vB_Library
in package
vB_Library_Page
Tags
Table of Contents
- MIN_PRECACHELIFE = 300
- $instance : mixed
- $lastCacheData : mixed
- $lastpreCache : mixed
- $preCacheInfo : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- 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() : vB_PageCache
- 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.
- __construct() : mixed
- getLibraryClassNameInternal() : mixed
Constants
MIN_PRECACHELIFE
public
mixed
MIN_PRECACHELIFE
= 300
Properties
$instance
protected
static mixed
$instance
= array()
$lastCacheData
protected
mixed
$lastCacheData
= array()
$lastpreCache
protected
mixed
$lastpreCache
= alse
$preCacheInfo
protected
mixed
$preCacheInfo
= array()
Methods
__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —clearCache()
public
static clearCache() : mixed
Return values
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
Return values
mixed —getHomePages()
Returns a list of pages to show as the home page options in quick config
public
getHomePages() : mixed
Return values
mixed —getOrphanedPagetemplates()
public
getOrphanedPagetemplates([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —getURLs()
public
getURLs([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —instance()
Returns singleton instance of self.
public
static instance(mixed $class) : vB_PageCache
Parameters
- $class : mixed
Return values
vB_PageCache —- Reference to singleton instance of the cache handler
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) : mixed
Parameters
- $text : mixed
- $type : mixed
- $nodeid : mixed
- $userid : mixed = null
- $insertNotifications : mixed = true
- $currentuserid : mixed
Return values
mixed —preload()
This preloads information for the current page.
public
preload(mixed $pageKey) : mixed
Parameters
- $pageKey : mixed
Return values
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
Return values
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.
Return values
mixed —__construct()
protected
__construct() : mixed
Return values
mixed —getLibraryClassNameInternal()
protected
static getLibraryClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed