ilCopyWizardSettingsXMLParser Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

ilCopyWizardSettingsXMLParser::__construct

(

string

$xml

)

Definition at line 25 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 120 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 105 of file class.ilCopyWizardSettingsXMLParser.php.

References $options.

                                : array
    {
        return $this->options;
    }

getSourceId()

ilCopyWizardSettingsXMLParser::getSourceId

(

)

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

References $source_id.

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

getTargetId()

ilCopyWizardSettingsXMLParser::getTargetId

(

)

Definition at line 115 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 44 of file class.ilCopyWizardSettingsXMLParser.php.

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

Referenced by setHandlers().

                                                                                    : 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:

Here is the caller graph for this function:

handlerCharacterData()

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

Parameters

XMLParser | resource

$a_xml_parser

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

Referenced by setHandlers().

                                                                       : void
    {
    }

Here is the caller graph for this function:

handlerEndTag()

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

Parameters

XMLParser | resource

$a_xml_parser

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

Referenced by setHandlers().

                                                                : void
    {
    }

Here is the caller graph for this function:

setHandlers()

ilCopyWizardSettingsXMLParser::setHandlers

(

$a_xml_parser

)

Parameters

XMLParser | resource

$a_xml_parser

Returns

void

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

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }

Here is the call graph for this function:

Field Documentation

$options

array ilCopyWizardSettingsXMLParser::$options = []

private

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

Referenced by getOptions().

$source_id

int ilCopyWizardSettingsXMLParser::$source_id = 0

private

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

Referenced by getSourceId().

$target_id

int ilCopyWizardSettingsXMLParser::$target_id = 0

private

Definition at line 23 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