Inheritance diagram for ilCopyWizardSettingsXMLParser:

Collaboration diagram for ilCopyWizardSettingsXMLParser:

Public Member Functions
	__construct (string $xml)

	setHandlers ($a_xml_parser)

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)

	getOptions ()

	getSourceId ()

	getTargetId ()

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Static Private Member Functions
static	getActionForString ($s)

Private Attributes
array	$options = []

int	$source_id = 0

int	$target_id = 0

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Detailed Description

Definition at line 12 of file class.ilCopyWizardSettingsXMLParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilCopyWizardSettingsXMLParser::__construct ( string $xml )

Definition at line 18 of file class.ilCopyWizardSettingsXMLParser.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilSaxParser\setXMLContent().

     {
         parent::__construct('', true);
         $this->setXMLContent($xml);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getActionForString()

static ilCopyWizardSettingsXMLParser::getActionForString ( $s )

staticprivate

Definition at line 114 of file class.ilCopyWizardSettingsXMLParser.php.

References ilCopyWizardOptions\COPY_WIZARD_COPY, ilCopyWizardOptions\COPY_WIZARD_LINK, and ilCopyWizardOptions\COPY_WIZARD_OMIT.

                                                   : int
     {
         if ($s === "COPY") {
             return ilCopyWizardOptions::COPY_WIZARD_COPY;
         }
 
         if ($s === "LINK") {
             return ilCopyWizardOptions::COPY_WIZARD_LINK;
         }
 
         return ilCopyWizardOptions::COPY_WIZARD_OMIT;
     }

◆ getOptions()

ilCopyWizardSettingsXMLParser::getOptions ( )

Definition at line 99 of file class.ilCopyWizardSettingsXMLParser.php.

References $options.

                                 : array
     {
         return $this->options;
     }

◆ getSourceId()

ilCopyWizardSettingsXMLParser::getSourceId ( )

Definition at line 104 of file class.ilCopyWizardSettingsXMLParser.php.

References $source_id.

                                  : ?int
     {
         return $this->source_id;
     }

◆ getTargetId()

ilCopyWizardSettingsXMLParser::getTargetId ( )

Definition at line 109 of file class.ilCopyWizardSettingsXMLParser.php.

References $target_id.

                                  : ?int
     {
         return $this->target_id;
     }

◆ handlerBeginTag()

ilCopyWizardSettingsXMLParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

Parameters

XMLParser | resource $a_xml_parser

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

References $DIC, $id, ilObject\_isInTrash(), ilCopyWizardOptions\COPY_WIZARD_COPY, ilCopyWizardOptions\COPY_WIZARD_LINK, ilObjectFactory\getTypeByRefId(), and ILIAS\Repository\int().

                                                                                     : void
     {
         global $DIC;
 
         $objDefinition = $DIC['objDefinition'];
         $ilAccess = $DIC['ilAccess'];
         $tree = $DIC['tree'];
 
         switch ($a_name) {
             case 'Settings':
                 $this->options = array();
                 $this->source_id = (int) $a_attribs["source_id"];
                 if (ilObject::_isInTrash($this->source_id)) {
                     throw new ilSaxParserException("Source id " . $this->source_id . " is in trash");
                 }
                 $this->target_id = (int) $a_attribs["target_id"];
                 if (ilObject::_isInTrash($this->target_id)) {
                     throw new ilSaxParserException("target id" . $this->target_id . " is in trash");
                 }
                 break;
             case 'Option':
                 $id = (int) $a_attribs["id"];
                 if (ilObject::_isInTrash($id)) {
                     throw new ilSaxParserException("Id $id is in trash");
                 }
                 if (!$tree->isInTree($id)) {
                     throw new ilSaxParserException("Id $id does not exist");
                 }
 
                 $action = self::getActionForString($a_attribs["action"]);
                 $type = ilObjectFactory::getTypeByRefId($id);
 
                 switch ($action) {
                     case ilCopyWizardOptions::COPY_WIZARD_COPY:
                         $perm_copy = $ilAccess->checkAccess('copy', '', $id);
                         $copy = $objDefinition->allowCopy($type);
 
                         if ($perm_copy && $copy) {
                             $this->options [$id] = array("type" => $action);
                         } elseif ($copy && !$perm_copy) {
                             throw new ilSaxParserException("Missing copy permission for object " . $id);
                         } elseif (!$copy) {
                             throw new ilSaxParserException("Copy for object " . $id . " of type " . $type . " is not supported");
                         }
                         break;
                     case ilCopyWizardOptions::COPY_WIZARD_LINK:
                         $perm_link = $ilAccess->checkAccess('write', '', $id);
                         $link = $objDefinition->allowLink($type);
 
                         if ($perm_link && $link) {
                             $this->options [$id] = array("type" => $action);
                         } elseif ($link && !$perm_link) {
                             throw new ilSaxParserException("Missing write permission for object " . $id);
                         } elseif (!$link) {
                             throw new ilSaxParserException("Link for object " . $id . " of type " . $type . " is not supported");
                         }
                         break;
                 }
         }
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilCopyWizardSettingsXMLParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

Parameters

XMLParser | resource $a_xml_parser

Definition at line 137 of file class.ilCopyWizardSettingsXMLParser.php.

                                                                        : void
     {
     }

◆ handlerEndTag()

ilCopyWizardSettingsXMLParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

XMLParser | resource $a_xml_parser

Definition at line 130 of file class.ilCopyWizardSettingsXMLParser.php.

                                                                 : void
     {
     }

◆ setHandlers()

ilCopyWizardSettingsXMLParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Definition at line 28 of file class.ilCopyWizardSettingsXMLParser.php.

                                               : void
     {
         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');
     }

Field Documentation

◆ $options

array ilCopyWizardSettingsXMLParser::$options = []

private

Definition at line 14 of file class.ilCopyWizardSettingsXMLParser.php.

Referenced by getOptions().

◆ $source_id

int ilCopyWizardSettingsXMLParser::$source_id = 0

private

Definition at line 15 of file class.ilCopyWizardSettingsXMLParser.php.

Referenced by getSourceId().

◆ $target_id

int ilCopyWizardSettingsXMLParser::$target_id = 0

private

Definition at line 16 of file class.ilCopyWizardSettingsXMLParser.php.

Referenced by getTargetId().

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

components/ILIAS/soap/classes/class.ilCopyWizardSettingsXMLParser.php

Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActionForString()

◆ getOptions()

◆ getSourceId()

◆ getTargetId()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setHandlers()

Field Documentation

◆ $options

◆ $source_id

◆ $target_id