ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilContainerReferenceXmlParser Class Reference

Group Import Parser. More...

+ Inheritance diagram for ilContainerReferenceXmlParser:
+ Collaboration diagram for ilContainerReferenceXmlParser:

Public Member Functions

 __construct ($a_xml, $a_parent_id=0)
 Constructor.
 getParentId ()
 Get parent id.
 setHandlers ($a_xml_parser)
 set event handler should be overwritten by inherited class private
 startParsing ()
 start the parser
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element
 handlerEndTag ($a_xml_parser, $a_name)
 Handler end tag.
 handlerCharacterData ($a_xml_parser, $a_data)
 handler for character data
 setMode ($mode)
 Set import mode.
 setReference (ilContainerReference $ref)
 Set container reference.
 getReference ()
 Get container reference.
- Public Member Functions inherited from ilSaxParser
 ilSaxParser ($a_xml_file= '', $throwException=false)
 Constructor setup ILIAS global object public.
 setXMLContent ($a_xml_content)
 getXMLContent ()
 getInputType ()
 createParser ()
 create parser
 setOptions ($a_xml_parser)
 set parser options
 openXMLFile ()
 open xml file
 parse ($a_xml_parser, $a_fp=null)
 parse xml file
 freeParser ($a_xml_parser)
 free xml parser handle
 setThrowException ($throwException)
 set error handling
- Public Member Functions inherited from PEAR
 PEAR ($error_class=null)
 Constructor.
 _PEAR ()
 Destructor (the emulated type of...).
getStaticProperty ($class, $var)
 If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them.
 registerShutdownFunc ($func, $args=array())
 Use this function to register a shutdown method for static classes.
 isError ($data, $code=null)
 Tell whether a value is a PEAR error.
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled.
 expectError ($code= '*')
 This method is used to tell which errors you expect to get.
 popExpect ()
 This method pops one element off the expected error codes stack.
 _checkDelExpect ($error_code)
 This method checks unsets an error code if available.
 delExpect ($error_code)
 This method deletes all occurences of the specified element from the expected error codes stack.
raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
 This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied.
throwError ($message=null, $code=null, $userinfo=null)
 Simpler form of raiseError with fewer options.
 staticPushErrorHandling ($mode, $options=null)
 staticPopErrorHandling ()
 pushErrorHandling ($mode, $options=null)
 Push a new error handler on top of the error handler options stack.
 popErrorHandling ()
 Pop the last error handler used.
 loadExtension ($ext)
 OS independant PHP extension load.

Data Fields

const MODE_CREATE = 1
const MODE_UPDATE = 2
- Data Fields inherited from ilSaxParser
 $input_type = null
 $xml_content = ''
 $ilias
 $lng
 $xml_file
 $throwException = false
- Data Fields inherited from PEAR
 $_debug = false
 $_default_error_mode = null
 $_default_error_options = null
 $_default_error_handler = ''
 $_error_class = 'PEAR_Error'
 $_expected_errors = array()

Protected Member Functions

 save ()
 Save category object.
- Protected Member Functions inherited from ilSaxParser
 handleError ($message, $code)
 use given error handler to handle error message or internal ilias error message handle

Private Attributes

 $ref = null
 $parent_id = 0

Detailed Description

Group Import Parser.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 38 of file class.ilContainerReferenceXmlParser.php.

Constructor & Destructor Documentation

ilContainerReferenceXmlParser::__construct (   $a_xml,
  $a_parent_id = 0 
)

Constructor.

Parameters
string$a_xml_filexml file

public

Definition at line 54 of file class.ilContainerReferenceXmlParser.php.

References MODE_CREATE, and ilSaxParser\setXMLContent().

+ Here is the call graph for this function:

Member Function Documentation

ilContainerReferenceXmlParser::getParentId ( )

Get parent id.

Returns
type

Definition at line 66 of file class.ilContainerReferenceXmlParser.php.

References $parent_id.

Referenced by save().

{
}

+ Here is the caller graph for this function:

ilContainerReferenceXmlParser::getReference ( )

Get container reference.

Returns
ilContainerReference

Definition at line 215 of file class.ilContainerReferenceXmlParser.php.

References $ref.

Referenced by handlerBeginTag(), handlerEndTag(), and save().

{
return $this->ref;
}

+ Here is the caller graph for this function:

ilContainerReferenceXmlParser::handlerBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element

Definition at line 101 of file class.ilContainerReferenceXmlParser.php.

References $ilErr, getReference(), and ilContainerReference\TITLE_TYPE_REUSE.

{
global $ilErr;
switch($a_name)
{
case "ContainerReference":
break;
case 'Title':
switch($a_attribs['type'])
{
break;
default:
break;
}
break;
case 'Target':
$this->getReference()->setTargetId($a_attribs['id']);
break;
}
}

+ Here is the call graph for this function:

ilContainerReferenceXmlParser::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Definition at line 157 of file class.ilContainerReferenceXmlParser.php.

{
#$a_data = str_replace("<","&lt;",$a_data);
#$a_data = str_replace(">","&gt;",$a_data);
if(!empty($a_data))
{
$this->cdata .= $a_data;
}
}
ilContainerReferenceXmlParser::handlerEndTag (   $a_xml_parser,
  $a_name 
)

Handler end tag.

Parameters
type$a_xml_parser
type$a_name

Definition at line 135 of file class.ilContainerReferenceXmlParser.php.

References getReference(), save(), and ilContainerReference\TITLE_TYPE_CUSTOM.

{
switch($a_name)
{
case "ContainerReference":
$this->save();
break;
case 'Title':
if($this->getReference()->getTitleType() == ilContainerReference::TITLE_TYPE_CUSTOM)
{
$this->getReference()->setTitle(trim($this->cdata));
}
break;
}
$this->cdata = '';
}

+ Here is the call graph for this function:

ilContainerReferenceXmlParser::save ( )
protected

Save category object.

Returns
type

mode can be create or update

Definition at line 172 of file class.ilContainerReferenceXmlParser.php.

References getParentId(), getReference(), and ilCategoryXmlParser\MODE_CREATE.

Referenced by handlerEndTag().

{
{
$this->create();
$this->getReference()->create();
$this->getReference()->createReference();
$this->getReference()->putInTree($this->getParentId());
$this->getReference()->setPermissions($this->getParentId());
}
$this->getReference()->update();
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilContainerReferenceXmlParser::setHandlers (   $a_xml_parser)

set event handler should be overwritten by inherited class private

Reimplemented from ilSaxParser.

Definition at line 76 of file class.ilContainerReferenceXmlParser.php.

{
xml_set_object($a_xml_parser,$this);
xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
}
ilContainerReferenceXmlParser::setMode (   $mode)

Set import mode.

Parameters
type$mode

Definition at line 196 of file class.ilContainerReferenceXmlParser.php.

{
$this->mode = $mode;
}
ilContainerReferenceXmlParser::setReference ( ilContainerReference  $ref)

Set container reference.

Parameters
ilContainerReference$ref

Definition at line 206 of file class.ilContainerReferenceXmlParser.php.

References $ref.

{
$this->ref = $ref;
}
ilContainerReferenceXmlParser::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

Definition at line 86 of file class.ilContainerReferenceXmlParser.php.

References $ref.

{
if($this->ref instanceof ilContainerReference)
{
return $this->ref;
}
return 0;
}

Field Documentation

ilContainerReferenceXmlParser::$parent_id = 0
private

Definition at line 44 of file class.ilContainerReferenceXmlParser.php.

Referenced by getParentId().

ilContainerReferenceXmlParser::$ref = null
private
const ilContainerReferenceXmlParser::MODE_CREATE = 1

Definition at line 40 of file class.ilContainerReferenceXmlParser.php.

Referenced by __construct().

const ilContainerReferenceXmlParser::MODE_UPDATE = 2

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