vBulletin 5.6.5 API

vB_Utility_PageRestore
in package
Uses vB_Trait_NoSerialize

vB_Utility_PageRestore

Tags
access

public

Table of Contents

$assertor  : object
Database assertor object
$fileVersions  : array<string|int, mixed>
Array of filenames and their versions to display to the user.
$xml  : array<string|int, mixed>
Array of parsed XML information read from files.
$xmldir  : string
Directory to look for the XML files in.
__construct()  : mixed
Constructor
__serialize()  : mixed
__sleep()  : mixed
__unserialize()  : mixed
__wakeup()  : mixed
getDbPageTemplateByPageTemplateId()  : array<string|int, mixed>
Returns a page template array from the database
getDbRouteByRouteId()  : array<string|int, mixed>
Returns a route array from the database
getFileVersions()  : array<string|int, mixed>
Returns the array of file names and versions for display to user.
getMatchingPageFromDbByXmlGuid()  : array<string|int, mixed>
Returns an array of page information for the matching page. The page is matched based on the route "name". If no route name is available, it is matched based on the page GUID.
getPageFromXmlByGuid()  : array<string|int, mixed>
Returns the page array from the XML file, based on the passed GUID
getPagesFromXml()  : array<string|int, mixed>
Returns an array of all pages from the XML file.
getPageTitleByGuid()  : mixed
Returns the phrased page title based on the GUID
getXmlPageTemplateByPageGuid()  : array<string|int, mixed>
Returns a page template array from the XML file. The page template is matched from the passed Page GUID.
getXmlRouteByPageGuid()  : array<string|int, mixed>
Returns a route array from the XML file. The route is matched from the passed Page GUID.
restorePage()  : mixed
Restores a page.
loadXmlFile()  : mixed
Loads and parses an XML file into the $this->xml property.

Properties

$assertor

Database assertor object

protected object $assertor = ull

$fileVersions

Array of filenames and their versions to display to the user.

protected array<string|int, mixed> $fileVersions = array()

$xml

Array of parsed XML information read from files.

protected array<string|int, mixed> $xml = array()

$xmldir

Directory to look for the XML files in.

protected string $xmldir = ''

Methods

__construct()

Constructor

public __construct(mixed $xmldir) : mixed
Parameters
$xmldir : mixed
Return values
mixed

__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

getDbPageTemplateByPageTemplateId()

Returns a page template array from the database

public getDbPageTemplateByPageTemplateId(mixed $pagetemplateid) : array<string|int, mixed>
Parameters
$pagetemplateid : mixed
Return values
array<string|int, mixed>

Array of page template information from the database

getDbRouteByRouteId()

Returns a route array from the database

public getDbRouteByRouteId(mixed $routeid) : array<string|int, mixed>
Parameters
$routeid : mixed
Return values
array<string|int, mixed>

Array of route information from the database

getFileVersions()

Returns the array of file names and versions for display to user.

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

File names and versions

getMatchingPageFromDbByXmlGuid()

Returns an array of page information for the matching page. The page is matched based on the route "name". If no route name is available, it is matched based on the page GUID.

public getMatchingPageFromDbByXmlGuid(mixed $guid) : array<string|int, mixed>
Parameters
$guid : mixed
Return values
array<string|int, mixed>

Array of page information from the database

getPageFromXmlByGuid()

Returns the page array from the XML file, based on the passed GUID

public getPageFromXmlByGuid(mixed $guid) : array<string|int, mixed>
Parameters
$guid : mixed
Return values
array<string|int, mixed>

Array of page information from the XML file

getPagesFromXml()

Returns an array of all pages from the XML file.

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

Array of page information from the XML file

getPageTitleByGuid()

Returns the phrased page title based on the GUID

public getPageTitleByGuid(mixed $guid) : mixed
Parameters
$guid : mixed
Return values
mixed

getXmlPageTemplateByPageGuid()

Returns a page template array from the XML file. The page template is matched from the passed Page GUID.

public getXmlPageTemplateByPageGuid(mixed $guid) : array<string|int, mixed>
Parameters
$guid : mixed
Return values
array<string|int, mixed>

Array of page template information from the XML file

getXmlRouteByPageGuid()

Returns a route array from the XML file. The route is matched from the passed Page GUID.

public getXmlRouteByPageGuid(mixed $guid) : array<string|int, mixed>
Parameters
$guid : mixed
Return values
array<string|int, mixed>

Array of route information from the XML file

restorePage()

Restores a page.

public restorePage(mixed $guid[, mixed $printMessage = true ]) : mixed

Specifically, this restores the page, page template, and route information so it reflects the values present at initial install. This is meant to be used only on the vBulletin default pages.

Parameters
$guid : mixed
$printMessage : mixed = true
Return values
mixed

loadXmlFile()

Loads and parses an XML file into the $this->xml property.

protected loadXmlFile(mixed $itemname) : mixed
Parameters
$itemname : mixed
Return values
mixed

Search results