IP.Board  3.3.0
skinImportExport Class Reference

Public Member Functions

 __construct (ipsRegistry $registry)
 exportAllAppCSS ($setID=0)
 exportAllAppTemplates ($setID=0, $setOnly=TRUE)
 exportCSSAppXML ($app_dir, $setID=0)
 exportTemplateAppXML ($app_dir, $setID=0, $setOnly=TRUE)
 generateCSSXML ($app_dir='core', $setID=0, $setOnly=FALSE)
 generateImagesXMLArchive ($imgDir)
 generateInfoXML ($setID=0)
 generateMasterSkinSetXML ($skinIDs)
 generateReplacementsXML ($setID=0, $setOnly=FALSE)
 generateSetXMLArchive ($setID=0, $setOnly=FALSE, $appslimit=null)
 generateTemplateXML ($app, $setID=0, $setOnly=FALSE)
 importAllAppTemplates ()
 importCSSAppXML ($app, $skinKey, $setID=0)
 importImagesXMLArchive ($content, $imageSetName, $setID=0)
 importReplacementsXMLArchive ($content, $setID=0)
 importSetXMLArchive ($content, $parentID=0, $imageDir='', $setName='', $upgrading=FALSE)
 importTemplateAppXML ($app, $skinKey, $setID=0, $ignoreAddedEditedFlag=false)
 parseCSSXML ($xmlContents)
 parseInfoXML ($xmlContents)
 parseReplacementsXML ($xmlContents)
 parseTemplatesXML ($xmlContents)

Protected Attributes

 $cache
 $caches
 $DB
 $lang
 $member
 $memberData
 $registry
 $request
 $settings

Constructor & Destructor Documentation

__construct ( ipsRegistry registry)

#@- Constructor

public

Parameters:
objectRegistry object
Returns:
void

Member Function Documentation

exportAllAppCSS ( setID = 0)

Export all Apps CSS

public

Parameters:
int[Set ID - 0/root if omitted]
Returns:
void
exportAllAppTemplates ( setID = 0,
setOnly = TRUE 
)

Export all Apps skin files

public

Parameters:
int[Set ID - 0/root if omitted]
boolInclude root bits in any XML export. Default is true
Returns:
void
exportCSSAppXML ( app_dir,
setID = 0 
)

Export template CSS into app dirs

public

Parameters:
stringApp to export into
intSet ID (0 / root by default )
Returns:
void
exportTemplateAppXML ( app_dir,
setID = 0,
setOnly = TRUE 
)

Export template XML into app dirs

public

Parameters:
stringApp to export into
int[Set ID (0/root if omitted)]
boolInclude root bits in any XML export. Default is true
Returns:
void
generateCSSXML ( app_dir = 'core',
setID = 0,
setOnly = FALSE 
)

Generate XML CSS data file

public

Parameters:
intSet ID
booleanJust get the changes for this set (if TRUE)
Returns:
mixed bool, or XML
generateImagesXMLArchive ( imgDir)

Generate an XML archive for an image set

public

Parameters:
stringImage Directory
Returns:
mixed bool, or xml contents
generateInfoXML ( setID = 0)

Generate XML Information data file

public

Parameters:
intSet ID
Returns:
string XML
generateMasterSkinSetXML ( skinIDs)

Generate the master skin set files

public

Parameters:
arrayArray of IDs
Returns:
string XML contents
generateReplacementsXML ( setID = 0,
setOnly = FALSE 
)

Generate XML Replacements data file

public

Parameters:
intSet ID
booleanJust get the changes for this set (if TRUE)
Returns:
mixed bool, or XML
generateSetXMLArchive ( setID = 0,
setOnly = FALSE,
appslimit = null 
)

Generate XML Archive for skin set

public

Parameters:
intSkin set ID
booleanModifications in this set only
array[Array of apps to export from. Default is all]
Returns:
string XML
generateTemplateXML ( app,
setID = 0,
setOnly = FALSE 
)

Generate XML template data file

public

Parameters:
stringApp
intSet ID
booleanJust get the changes for this set (if TRUE)
Returns:
mixed bool, or XML

Import all Apps skin files

Returns:
void
importCSSAppXML ( app,
skinKey,
setID = 0 
)

Import CSS for a single app

public

Parameters:
stringApp
stringSkin key to import
intSet ID
Returns:
mixed bool, or number of items added
importImagesXMLArchive ( content,
imageSetName,
setID = 0 
)

Imports a set XMLArchive

public

Parameters:
stringXMLArchive content to import
stringImages directory name to use.
int[ Set ID to apply to (if desired) ]
Returns:
mixed Number of items added, or bool
importReplacementsXMLArchive ( content,
setID = 0 
)

Imports a replacements XMLArchive

public

Parameters:
stringXMLArchive content to import
intSet ID to apply to (if desired)
Returns:
int Number of items added
importSetXMLArchive ( content,
parentID = 0,
imageDir = '',
setName = '',
upgrading = FALSE 
)

Imports a set XMLArchive

public

Parameters:
stringXMLArchive content to import
int[ Skin set parent. If omitted, it will be made a root skin ]
string[ Images directory to use. If omitted, default skin's image dir is used ]
string[ Name of skin to create. If omitted, name from skin set is used ]
bool[ Whether or not we are attempting to upgrade an existing skin ]
Returns:
mixed bool, or number of items added
importTemplateAppXML ( app,
skinKey,
setID = 0,
ignoreAddedEditedFlag = false 
)

Import a single app

public

Parameters:
stringApp
stringSkin key to import
intSet ID
booleanSet the edited / added flags to 0 (from install, upgrade)
Returns:
mixed bool, or array of info
parseCSSXML ( xmlContents)

Parses an CSS XML file

public

Parameters:
stringXML
Returns:
array
parseInfoXML ( xmlContents)

Parses an info XML file

public

Parameters:
stringXML
Returns:
array
parseReplacementsXML ( xmlContents)

Parses an replacements XML file

public

Parameters:
stringXML
Returns:
array
parseTemplatesXML ( xmlContents)

Parses an CSS XML file

public

Parameters:
stringXML
Returns:
array

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables