vB_Xml_Import_PageTemplate
extends vB_Xml_Import
in package
Table of Contents
Constants
- OPTION_ADDSPECIFICWIDGETS = 32
- OPTION_ADDWIDGETS = 8
- OPTION_IGNOREMISSINGPARENTS = 4
- OPTION_IGNOREMISSINGROUTES = 2
- OPTION_OVERWRITE = 1
- OPTION_OVERWRITECOLUMN = 16
- TYPE_CHANNEL = 'channels'
- TYPE_PAGE = 'pages'
- TYPE_PAGETEMPLATE = 'pageTemplates'
- TYPE_ROUTE = 'routes'
- TYPE_SCREENLAYOUT = 'screenLayouts'
- TYPE_THEME = 'themes'
- TYPE_WIDGET = 'widgets'
Methods
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- getImportedId() : int
- Returns the id for an imported element
- importFromFile() : mixed
- Imports objects from the specified filepath
- importFromParsedXML() : mixed
- Imports objects from parsed XML starting at the base of the relevant objects.
- parseFile() : mixed
- replaceChannelGuidsInWidgetConfigs() : mixed
- Replaces the text "channelguid:<GUID>" in any config options with the actual channel nodeid. This must be called after channels are imported.
- replacePhrasePlaceholdersInWidgetConfigs() : mixed
- Replaces the text "phrase:<phrasevarname>" in any config options with the actual phrase text.
- setOptions() : mixed
- setOverwriteColumn() : mixed
- Sets the column to overwrite, if OPTION_OVERWRITECOLUMN is set
- setWidgetsToAdd() : mixed
- Sets widgets to be added in conjuction with the OPTION_ADDSPECIFICWIDGETS flag
Constants
OPTION_ADDSPECIFICWIDGETS
public
mixed
OPTION_ADDSPECIFICWIDGETS
= 32
OPTION_ADDWIDGETS
public
mixed
OPTION_ADDWIDGETS
= 8
OPTION_IGNOREMISSINGPARENTS
public
mixed
OPTION_IGNOREMISSINGPARENTS
= 4
OPTION_IGNOREMISSINGROUTES
public
mixed
OPTION_IGNOREMISSINGROUTES
= 2
OPTION_OVERWRITE
public
mixed
OPTION_OVERWRITE
= 1
OPTION_OVERWRITECOLUMN
public
mixed
OPTION_OVERWRITECOLUMN
= 16
TYPE_CHANNEL
public
mixed
TYPE_CHANNEL
= 'channels'
TYPE_PAGE
public
mixed
TYPE_PAGE
= 'pages'
TYPE_PAGETEMPLATE
public
mixed
TYPE_PAGETEMPLATE
= 'pageTemplates'
TYPE_ROUTE
public
mixed
TYPE_ROUTE
= 'routes'
TYPE_SCREENLAYOUT
public
mixed
TYPE_SCREENLAYOUT
= 'screenLayouts'
TYPE_THEME
public
mixed
TYPE_THEME
= 'themes'
TYPE_WIDGET
public
mixed
TYPE_WIDGET
= 'widgets'
Methods
__construct()
public
__construct([mixed $productid = 'vbulletin' ][, mixed $options = 9 ]) : mixed
Parameters
- $productid : mixed = 'vbulletin'
- $options : mixed = 9
__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>
__wakeup()
public
__wakeup() : void
getImportedId()
Returns the id for an imported element
public
static getImportedId(string $type[, string $guid = NULL ]) : int
Parameters
- $type : string
- $guid : string = NULL
Return values
intimportFromFile()
Imports objects from the specified filepath
public
importFromFile(string $filepath[, string $guid = false ]) : mixed
Parameters
- $filepath : string
- $guid : string = false
-
Only import the record associated with this guid
importFromParsedXML()
Imports objects from parsed XML starting at the base of the relevant objects.
public
importFromParsedXML(array<string|int, mixed> $parsedXML) : mixed
Parameters
- $parsedXML : array<string|int, mixed>
parseFile()
public
static parseFile(mixed $filepath) : mixed
Parameters
- $filepath : mixed
replaceChannelGuidsInWidgetConfigs()
Replaces the text "channelguid:<GUID>" in any config options with the actual channel nodeid. This must be called after channels are imported.
public
replaceChannelGuidsInWidgetConfigs() : mixed
replacePhrasePlaceholdersInWidgetConfigs()
Replaces the text "phrase:<phrasevarname>" in any config options with the actual phrase text.
public
replacePhrasePlaceholdersInWidgetConfigs() : mixed
This replaces placeholders in any widget config, even ones that already exist, which is why it needs to be done independently of the import, which does not overwrite existing widget instances.
setOptions()
public
setOptions(mixed $options) : mixed
Parameters
- $options : mixed
setOverwriteColumn()
Sets the column to overwrite, if OPTION_OVERWRITECOLUMN is set
public
setOverwriteColumn(mixed $column) : mixed
Parameters
- $column : mixed
setWidgetsToAdd()
Sets widgets to be added in conjuction with the OPTION_ADDSPECIFICWIDGETS flag
public
setWidgetsToAdd(array<string|int, mixed> $widgets) : mixed
Parameters
- $widgets : array<string|int, mixed>