class vB_Xml_Import_Widget extends vB_Xml_Import

Traits

Constants

OPTION_OVERWRITE

OPTION_IGNOREMISSINGROUTES

OPTION_IGNOREMISSINGPARENTS

OPTION_ADDWIDGETS

OPTION_OVERWRITECOLUMN

TYPE_ROUTE

TYPE_CHANNEL

TYPE_PAGE

TYPE_PAGETEMPLATE

TYPE_WIDGET

TYPE_THEME

TYPE_SCREENLAYOUT

WIDGETGUID_ABSTRACT_GLOBAL

Widget GUIDs

Properties

protected vB_dB_Assertor $db from vB_Xml_Import
protected int $options from vB_Xml_Import
protected array $parsedXML from vB_Xml_Import
protected $productid from vB_Xml_Import
static protected array $importedElements from vB_Xml_Import
protected string $overwriteColumn Column to overwrite, if OPTION_OVERWRITECOLUMN is set from vB_Xml_Import

Methods

__sleep()

No description

__wakeup()

No description

__construct($productid = 'vbulletin', $options = 9)

No description

setOptions($options)

No description

setOverwriteColumn(string $column)

Sets the column to overwrite, if OPTION_OVERWRITECOLUMN is set

static 
setImportedId($type, $guid, $newid)

Stores an imported element with the new id

static int
getImportedId(string $type, string $guid = NULL)

Returns the id for an imported element

importFromFile(string $filepath, string $guid = false)

Imports objects from the specified filepath

importFromParsedXML(array $parsedXML)

Imports objects from parsed XML starting at the base of the relevant objects.

import()

Imports the data from the XML file into the database

static 
parseFile($filepath)

No description

array
replacePhrasePlaceholdersInArray(array $array)

If an array value is of the form "phrase:" replace it with the actual phrase.

array
getXmlWidgetData()

Normalizes and returns widget data from XML

array
getAllWidgetData()

Gets all widget info from database, ready for the inheritance process

array
getDerivedWidgets()

Returns the derived widgets.

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Xml_Import at line 69
__construct($productid = 'vbulletin', $options = 9)

Parameters

$productid
$options

in vB_Xml_Import at line 76
setOptions($options)

Parameters

$options

in vB_Xml_Import at line 86
setOverwriteColumn(string $column)

Sets the column to overwrite, if OPTION_OVERWRITECOLUMN is set

Parameters

string $column Column name

in vB_Xml_Import at line 137
static protected setImportedId($type, $guid, $newid)

Stores an imported element with the new id

Parameters

$type
$guid
$newid

in vB_Xml_Import at line 148
static int getImportedId(string $type, string $guid = NULL)

Returns the id for an imported element

Parameters

string $type
string $guid

Return Value

int

in vB_Xml_Import at line 173
importFromFile(string $filepath, string $guid = false)

Imports objects from the specified filepath

Parameters

string $filepath
string $guid Only import the record associated with this guid

in vB_Xml_Import at line 183
importFromParsedXML(array $parsedXML)

Imports objects from parsed XML starting at the base of the relevant objects.

Parameters

array $parsedXML

at line 815
protected import()

Imports the data from the XML file into the database

in vB_Xml_Import at line 194
static parseFile($filepath)

Parameters

$filepath

in vB_Xml_Import at line 218
protected array replacePhrasePlaceholdersInArray(array $array)

If an array value is of the form "phrase:" replace it with the actual phrase.

Parameters

array $array

Return Value

array The array with phrases replaced.

at line 84
protected array getXmlWidgetData()

Normalizes and returns widget data from XML

Return Value

array Widget data

at line 110
protected array getAllWidgetData()

Gets all widget info from database, ready for the inheritance process

Return Value

array Widget data

at line 843
array getDerivedWidgets()

Returns the derived widgets.

WARNING: Only intended for use by unit tests. Do not use in any other context

Return Value

array Derived widgets