SKINIMPORT Class Reference

List of all members.

Public Member Functions

 SKINIMPORT ()
 reset ()
 readFile ($filename, $metaOnly=0)
 getSkinNames ()
 getTemplateNames ()
 getInfo ()
 writeToDatabase ($allowOverwrite=0)
 checkSkinNameClashes ()
 checkTemplateNameClashes ()
 startElement ($parser, $name, $attrs)
 endElement ($parser, $name)
 characterData ($parser, $data)
 getCharacterData ()
 clearCharacterData ()
 searchForCandidates ($dir)

Public Attributes

 $debug
 $parser
 $fp
 $metaDataRead
 $allRead
 $skins
 $templates
 $info
 $inXml
 $inData
 $inMeta
 $inSkin
 $inTemplate
 $currentName
 $currentPartName
 $cdata


Detailed Description

This class contains two classes that can be used for importing and exporting Nucleus skins: SKINIMPORT and SKINEXPORT

http://nucleuscms.org/license.txt GNU General Public License Copyright (C) 2002-2007 The Nucleus Group

Version:
Id
skinie.php 1159 2007-05-24 14:37:56Z kaigreve
Version:
NucleusJP
skinie.php,v 1.9.2.1 2007/09/05 07:46:30 kimitake Exp

Definition at line 22 of file skinie.php.


Member Function Documentation

SKINIMPORT::SKINIMPORT (  ) 

constructor initializes data structures

Definition at line 56 of file skinie.php.

References debug(), and reset().

SKINIMPORT::reset (  ) 

Definition at line 67 of file skinie.php.

Referenced by SKINIMPORT().

SKINIMPORT::readFile ( filename,
metaOnly = 0 
)

Reads an XML file into memory

Parameters:
$filename Which file to read
$metaOnly Set to 1 when only the metadata needs to be read (optional, default 0)

Definition at line 114 of file skinie.php.

References debug().

SKINIMPORT::getSkinNames (  ) 

Returns the list of skin names

Definition at line 164 of file skinie.php.

SKINIMPORT::getTemplateNames (  ) 

Returns the list of template names

Definition at line 171 of file skinie.php.

SKINIMPORT::getInfo (  ) 

Returns the extra information included in the XML file

Definition at line 178 of file skinie.php.

SKINIMPORT::writeToDatabase ( allowOverwrite = 0  ) 

Writes the skins and templates to the database

Parameters:
$allowOverwrite set to 1 when allowed to overwrite existing skins with the same name (default = 0)

Definition at line 189 of file skinie.php.

References $skinid, checkSkinNameClashes(), checkTemplateNameClashes(), TEMPLATE::createFromName(), SKIN::createFromName(), TEMPLATE::createNew(), and SKIN::createNew().

SKINIMPORT::checkSkinNameClashes (  ) 

returns an array of all the skin nameclashes (empty array when no name clashes)

Definition at line 249 of file skinie.php.

References SKIN::exists().

Referenced by writeToDatabase().

SKINIMPORT::checkTemplateNameClashes (  ) 

returns an array of all the template nameclashes (empty array when no name clashes)

Definition at line 264 of file skinie.php.

References TEMPLATE::exists().

Referenced by writeToDatabase().

SKINIMPORT::startElement ( parser,
name,
attrs 
)

Called by XML parser for each new start element encountered

Definition at line 278 of file skinie.php.

References clearCharacterData(), and debug().

SKINIMPORT::endElement ( parser,
name 
)

Called by the XML parser for each closing tag encountered

Definition at line 335 of file skinie.php.

References clearCharacterData(), debug(), and getCharacterData().

SKINIMPORT::characterData ( parser,
data 
)

Called by XML parser for data inside elements

Definition at line 380 of file skinie.php.

References debug().

SKINIMPORT::getCharacterData (  ) 

Returns the data collected so far

Definition at line 388 of file skinie.php.

Referenced by endElement().

SKINIMPORT::clearCharacterData (  ) 

Clears the data buffer

Definition at line 395 of file skinie.php.

Referenced by endElement(), and startElement().

SKINIMPORT::searchForCandidates ( dir  ) 

Static method that looks for importable XML files in subdirs of the given dir

Definition at line 402 of file skinie.php.

Referenced by ADMIN::action_skinieoverview().


Member Data Documentation

SKINIMPORT::$debug

Definition at line 26 of file skinie.php.

SKINIMPORT::$parser

Definition at line 29 of file skinie.php.

SKINIMPORT::$fp

Definition at line 30 of file skinie.php.

SKINIMPORT::$metaDataRead

Definition at line 33 of file skinie.php.

SKINIMPORT::$allRead

Definition at line 34 of file skinie.php.

SKINIMPORT::$skins

Definition at line 37 of file skinie.php.

SKINIMPORT::$templates

Definition at line 38 of file skinie.php.

SKINIMPORT::$info

Definition at line 39 of file skinie.php.

SKINIMPORT::$inXml

Definition at line 42 of file skinie.php.

SKINIMPORT::$inData

Definition at line 43 of file skinie.php.

SKINIMPORT::$inMeta

Definition at line 44 of file skinie.php.

SKINIMPORT::$inSkin

Definition at line 45 of file skinie.php.

SKINIMPORT::$inTemplate

Definition at line 46 of file skinie.php.

SKINIMPORT::$currentName

Definition at line 47 of file skinie.php.

SKINIMPORT::$currentPartName

Definition at line 48 of file skinie.php.

SKINIMPORT::$cdata

Definition at line 49 of file skinie.php.


The documentation for this class was generated from the following file:



Generated on Wed Jun 25 17:26:03 2008 by  doxygen 1.5.5