SeqTreeBuilder Class Reference

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

Collaboration diagram for SeqTreeBuilder:

Public Member Functions
	buildNodeSeqTree (string $file)

Static Public Member Functions
static	getObjectives (object $iNode, object $ioAct)
static	getADLSEQObjectives (object $iNode, object $ioAct)
static	getADLSeqMaps (object $iNode, object $curseqobj)
static	fillinADLSeqMaps (object $iNode, object $map)
static	getObjectiveMaps (object $iNode)
static	getRollupRules (object $iNode, object $ioAct)
static	getSequencingRules (object $iNode, object $ioAct)
static	extractSeqRuleConditions (object $iNode)
static	getAuxResources (object $iNode, object $ioAct)

Private Member Functions
	buildNode (object $node, ?object $seq, object $doc)
	extractSeqInfo (object $iNode, object $ioAct)

Static Private Member Functions
static	convert_to_bool (string $string)
static	lookupElement (object $iNode, ?string $iElement)

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 65 of file SeqTreeBuilder.php.

Member Function Documentation

buildNode()

SeqTreeBuilder::buildNode ( object  $node, ?object  $seq, object  $doc  )

private

Definition at line 128 of file SeqTreeBuilder.php.

References extractSeqInfo().

Referenced by buildNodeSeqTree().

                                                                       : SeqActivity
    {
        //create a new activity object
        $act = new SeqActivity();

        //set various attributes, if existent
        $act->setID(preg_replace('/(%20)+/', ' ', trim($node->getAttribute("identifier"))));

        $tempVal = preg_replace('/(%20)+/', ' ', trim($node->getAttribute("identifierref")));
        if ($tempVal) {
            $act->setResourceID($tempVal);
        }

        $tempVal = $node->getAttribute("isvisible");

        if ($tempVal) {
            $act->setIsVisible(self::convert_to_bool($tempVal));
        }



        //Proceed nested items
        $children = $node->childNodes;

        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            //elements only

            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                //only items are nested
                if ($curNode->localName === "item") {
                    //init;
                    $c_nestedAct = null;
                    $nestedAct = $this->buildNode($curNode, $seq, $doc);
                    if ($nestedAct != null) {
                        $act->AddChild((object) $nestedAct);
                    }
                } elseif ($curNode->localName === "title") {
                    $act->setTitle(self::lookupElement($curNode, null));
                } elseif ($curNode->localName === "completionThreshold") {
                    $tempVal = $curNode->getAttribute("minProgressMeasure");

                    if ($tempVal) {
                        $act->setCompletionThreshold($tempVal);
                    } elseif ($curNode->nodeValue != null && $curNode->nodeValue != '') {
                        $act->setCompletionThreshold((float) $curNode->nodeValue);
                    }

                    $tempVal = $curNode->getAttribute("progressWeight");

                    if ($tempVal) {
                        $act->setProgressWeight($tempVal);
                    }
                    $tempVal = $curNode->getAttribute("completedByMeasure");

                    if ($tempVal) {
                        $act->setCompletedByMeasure(self::convert_to_bool($tempVal));
                    }
                } elseif ($curNode->localName === "sequencing") {
                    $seqInfo = $curNode;
                    //get IDRef
                    $tempVal = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("IDRef")));
                    //only execute for referenced sequencing parts
                    if ($tempVal) {
                        //init seqGlobal
                        $seqGlobal = null;

                        //get all sequencing nodes in collections
                        $sequencing = $seq->getElementsByTagName("sequencing");

                        //lookup the matching sequencing element
                        foreach ($sequencing as $element) {
                            if (preg_replace('/(%20)+/', ' ', trim($element->getAttribute("ID"))) == $tempVal) {
                                $seqGlobal = $element;
                            }
                        }

                        //clone the global node
                        $seqInfo = $seqGlobal->cloneNode(true);

                        //back to the local node
                        $seqChildren = $curNode->childNodes;
                        for ($j = 0; $j < $seqChildren->length; $j++) {
                            //process local nodes
                            $curChild = $seqChildren->item($j);
                            if ($curChild->nodeType == XML_ELEMENT_NODE) {
                                //echo "\nFound Sequencing Element Node".$curChild->localName;
                                //add local to global sequencing info
                                $seqInfo->appendChild($curChild);
                            }
                        }
                    }
                    //extract the sequencing info, if we have one
                    //avoid working with
                    $act = $this->extractSeqInfo($seqInfo, $act);
                }
            }



            $item = $children->item($i)->nodeValue;
        }
        //add class
        //$c_act['_SeqActivity']=$act;
        return $act;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildNodeSeqTree()

SeqTreeBuilder::buildNodeSeqTree

(

string

$file

)

Definition at line 67 of file SeqTreeBuilder.php.

References buildNode().

                                                  : array
    {
        $doc = new DomDocument();
        $doc->load($file);
        $organizations = $doc->getElementsByTagName("organizations");

        //lookup default organization id
        $item = $organizations->item(0);
        if ($item !== null) {
            $default = preg_replace('/(%20)+/', ' ', trim($item->getAttribute("default")));
        }

        //get all organization nodes
        $organization = $doc->getElementsByTagName("organization");

        //lookup the default organization
        foreach ($organization as $element) {
            if (preg_replace('/(%20)+/', ' ', trim($element->getAttribute("identifier"))) == $default) {
                $default_organization = $element;
            }
        }

        //read seqCollection
        $seqCollection = $doc->getElementsByTagName("sequencingCollection")->item(0);

        $root = $this->buildNode($default_organization, $seqCollection, $doc);

        //return no data please check
        $objectivesGlobalToSystem = $default_organization->getAttributeNS("http://www.adlnet.org/xsd/adlseq_v1p3", "objectivesGlobalToSystem");

        $org = preg_replace('/(%20)+/', ' ', trim($default_organization->getAttribute("identifier")));

        //default true
        $globaltosystem = 1;

        if ($objectivesGlobalToSystem === "false") {
            $globaltosystem = 0;
        }

        //return no data please check
        $dataGlobalToSystem = $default_organization->getAttributeNS("http://www.adlnet.org/xsd/adlcp_v1p3", "sharedDataGlobalToSystem");

        //default true
        $dataglobaltosystem = 1;

        if ($dataGlobalToSystem === "false") {
            $dataglobaltosystem = 0;
        }

        //assign SeqActivity to top node
        $c_root['_SeqActivity'] = $root;

        $ret['global'] = $globaltosystem;
        $ret['dataglobal'] = $dataglobaltosystem;
        $ret['tree'] = $c_root;

        return $ret;
    }

Here is the call graph for this function:

convert_to_bool()

static SeqTreeBuilder::convert_to_bool ( string  $string )

staticprivate

Definition at line 964 of file SeqTreeBuilder.php.

                                                           : bool
    {
        return strtoupper($string) !== "FALSE";
    }

extractSeqInfo()

SeqTreeBuilder::extractSeqInfo ( object  $iNode, object  $ioAct  )

private

Definition at line 236 of file SeqTreeBuilder.php.

Referenced by buildNode().

                                                                 : object
    {
        //set sequencing information
        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "controlMode") {
                    //look for choice
                    $tempVal = $curNode->getAttribute("choice");
                    if ($tempVal) {
                        $ioAct->setControlModeChoice(self::convert_to_bool($tempVal));
                    }
                    //look for choiceExit
                    $tempVal = $curNode->getAttribute("choiceExit");
                    if ($tempVal) {
                        $ioAct->setControlModeChoiceExit(self::convert_to_bool($tempVal));
                    }

                    //look for flow
                    $tempVal = $curNode->getAttribute("flow");
                    if ($tempVal) {
                        $ioAct->setControlModeFlow(self::convert_to_bool($tempVal));
                    }

                    // Look for 'forwardOnly'
                    $tempVal = $curNode->getAttribute("forwardOnly");
                    if ($tempVal) {
                        $ioAct->setControlForwardOnly(self::convert_to_bool($tempVal));
                    }

                    // Look for 'useCurrentAttemptObjectiveInfo'
                    $tempVal = $curNode->getAttribute("useCurrentAttemptObjectiveInfo");
                    if ($tempVal) {
                        $ioAct->setUseCurObjective(self::convert_to_bool($tempVal));
                    }

                    // Look for 'useCurrentAttemptProgressInfo'
                    $tempVal = $curNode->getAttribute("useCurrentAttemptProgressInfo");
                    if ($tempVal) {
                        $ioAct->setUseCurProgress(self::convert_to_bool($tempVal));
                    }
                } elseif ($curNode->localName === "sequencingRules") {
                    $ioAct = self::getSequencingRules($curNode, $ioAct);
                } elseif ($curNode->localName === "limitConditions") {
                    // Look for 'useCurrentAttemptObjectiveInfo'
                    $tempVal = $curNode->getAttribute("attemptLimit");
                    if ($tempVal) {
                        $ioAct->setAttemptLimit($tempVal);
                    }

                    // Look for 'attemptAbsoluteDurationLimit'
                    $tempVal = $curNode->getAttribute("attemptAbsoluteDurationLimit");
                    if ($tempVal) {
                        $ioAct->setAttemptAbDur($tempVal);
                    }

                    // Look for 'attemptExperiencedDurationLimit'
                    $tempVal = $curNode->getAttribute("attemptExperiencedDurationLimit");
                    if ($tempVal) {
                        $ioAct->setAttemptExDur($tempVal);
                    }

                    // Look for 'activityAbsoluteDurationLimit'
                    $tempVal = $curNode->getAttribute("activityAbsoluteDurationLimit");
                    if ($tempVal) {
                        $ioAct->setActivityAbDur($tempVal);
                    }

                    // Look for 'activityExperiencedDurationLimit'
                    $tempVal = $curNode->getAttribute("activityExperiencedDurationLimit");
                    if ($tempVal) {
                        $ioAct->setActivityExDur($tempVal);
                    }

                    // Look for 'beginTimeLimit'
                    $tempVal = $curNode->getAttribute("beginTimeLimit");
                    if ($tempVal) {
                        $ioAct->setBeginTimeLimit($tempVal);
                    }

                    // Look for 'endTimeLimit'
                    $tempVal = $curNode->getAttribute("endTimeLimit");
                    if ($tempVal) {
                        $ioAct->setEndTimeLimit($tempVal);
                    }
                } elseif ($curNode->localName === "auxiliaryResources") {
                    $ioAct = self::getAuxResources($curNode, $ioAct);
                } elseif ($curNode->localName === "rollupRules") {
                    $ioAct = self::getRollupRules($curNode, $ioAct);
                } elseif ($curNode->localName === "objectives" && $curNode->namespaceURI === "http://www.imsglobal.org/xsd/imsss") {
                    $ioAct = self::getObjectives($curNode, $ioAct);
                } elseif ($curNode->localName === "objectives" && $curNode->namespaceURI === "http://www.adlnet.org/xsd/adlseq_v1p3") {
                    $ioAct = self::getADLSEQObjectives($curNode, $ioAct);
                } elseif ($curNode->localName === "randomizationControls") {
                    // Look for 'randomizationTiming'
                    $tempVal = $curNode->getAttribute("randomizationTiming");
                    if ($tempVal) {
                        $ioAct->setRandomTiming($tempVal);
                    }

                    // Look for 'selectCount'
                    $tempVal = $curNode->getAttribute("selectCount");
                    if ($tempVal) {
                        $ioAct->setSelectCount($tempVal);
                    }

                    // Look for 'reorderChildren'
                    $tempVal = $curNode->getAttribute("reorderChildren");
                    if ($tempVal) {
                        $ioAct->setReorderChildren(self::convert_to_bool($tempVal));
                    }

                    // Look for 'selectionTiming'
                    $tempVal = $curNode->getAttribute("selectionTiming");
                    if ($tempVal) {
                        $ioAct->setSelectionTiming($tempVal);
                    }
                } elseif ($curNode->localName === "deliveryControls") {
                    // Look for 'tracked'
                    $tempVal = $curNode->getAttribute("tracked");
                    if ($tempVal) {
                        $ioAct->setIsTracked(self::convert_to_bool($tempVal));
                    }

                    // Look for 'completionSetByContent'
                    $tempVal = $curNode->getAttribute("completionSetByContent");
                    if ($tempVal) {
                        $ioAct->setSetCompletion(self::convert_to_bool($tempVal));
                    }

                    // Look for 'objectiveSetByContent'
                    $tempVal = $curNode->getAttribute("objectiveSetByContent");
                    if ($tempVal) {
                        $ioAct->setSetObjective(self::convert_to_bool($tempVal));
                    }
                } elseif ($curNode->localName === "constrainedChoiceConsiderations") {
                    // Look for 'preventActivation'
                    $tempVal = $curNode->getAttribute("preventActivation");
                    if ($tempVal) {
                        $ioAct->setPreventActivation(self::convert_to_bool($tempVal));
                    }

                    // Look for 'constrainChoice'
                    $tempVal = $curNode->getAttribute("constrainChoice");
                    if ($tempVal) {
                        $ioAct->setConstrainChoice(self::convert_to_bool($tempVal));
                    }
                } elseif ($curNode->localName === "rollupConsiderations") {
                    // Look for 'requiredForSatisfied'
                    $tempVal = $curNode->getAttribute("requiredForSatisfied");
                    if ($tempVal) {
                        $ioAct->setRequiredForSatisfied($tempVal);
                    }

                    // Look for 'requiredForNotSatisfied'
                    $tempVal = $curNode->getAttribute("requiredForNotSatisfied");
                    if ($tempVal) {
                        $ioAct->setRequiredForNotSatisfied($tempVal);
                    }

                    // Look for 'requiredForCompleted'
                    $tempVal = $curNode->getAttribute("requiredForCompleted");
                    if ($tempVal) {
                        $ioAct->setRequiredForCompleted($tempVal);
                    }

                    // Look for 'requiredForIncomplete'
                    $tempVal = $curNode->getAttribute("requiredForIncomplete");
                    if ($tempVal) {
                        $ioAct->setRequiredForIncomplete($tempVal);
                    }

                    // Look for 'measureSatisfactionIfActive'
                    $tempVal = $curNode->getAttribute("measureSatisfactionIfActive");
                    if ($tempVal) {
                        $ioAct->setSatisfactionIfActive(self::convert_to_bool($tempVal));
                    }
                }
            }  //end note-type check
        } //end for-loop

        return $ioAct;
    }

Here is the caller graph for this function:

extractSeqRuleConditions()

static SeqTreeBuilder::extractSeqRuleConditions ( object  $iNode )

static

Definition at line 862 of file SeqTreeBuilder.php.

References COMBINATION_ALL.

                                                                  : array
    {
        $tempVal = null;
        $condSet = new SeqConditionSet(false);

        $conditions = array();
        $tempVal = $iNode->getAttribute("conditionCombination");
        if ($tempVal) {
            $condSet->mCombination = $tempVal;
        } else {
            $condSet->mCombination = COMBINATION_ALL;
        }
        $condInfo = $iNode->childNodes;
        for ($i = 0; $i < $condInfo->length; $i++) {
            $curCond = $condInfo->item($i);
            if ($curCond->nodeType == XML_ELEMENT_NODE) {
                if ($curCond->localName === "ruleCondition") {
                    $cond = new SeqCondition();

                    //look for condition
                    $tempVal = $curCond->getAttribute("condition");
                    if ($tempVal) {
                        $cond->mCondition = $tempVal;
                    }

                    // Look for 'referencedObjective'
                    $tempVal = preg_replace('/(%20)+/', ' ', trim($curCond->getAttribute("referencedObjective")));
                    if ($tempVal) {
                        $cond->mObjID = $tempVal;
                    }

                    // Look for 'measureThreshold'
                    $tempVal = $curCond->getAttribute("measureThreshold");
                    if ($tempVal) {
                        $cond->mThreshold = $tempVal;
                    }

                    // Look for 'operator'
                    $tempVal = $curCond->getAttribute("operator");
                    if ($tempVal) {
                        if ($tempVal === 'not') {
                            $cond->mNot = true;
                        } else {
                            $cond->mNot = false;
                        }
                    }

                    //add class
                    $c_cond['_SeqCondition'] = $cond;
                    $conditions[] = $c_cond;
                }
            }
        }

        if (count($conditions) > 0) {
            $condSet->mConditions = $conditions;
        } else {
            $condSet->mConditions = null;
        }
        //add class
        $c_condSet['_SeqConditionSet'] = $condSet;
        return $c_condSet;
    }

fillinADLSeqMaps()

static SeqTreeBuilder::fillinADLSeqMaps ( object  $iNode, object  $map  )

static

Definition at line 552 of file SeqTreeBuilder.php.

                                                                       : object
    {
        if ($map->mGlobalObjID == null) {
            $map->mGlobalObjID = preg_replace('/(%20)+/', ' ', trim($iNode->getAttribute("targetObjectiveID")));
        }

        $tempVal = $iNode->getAttribute("readRawScore");
        if ($tempVal) {
            $map->mReadRawScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("readMinScore");
        if ($tempVal) {
            $map->mReadMinScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("readMaxScore");
        if ($tempVal) {
            $map->mReadMaxScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("readCompletionStatus");
        if ($tempVal) {
            $map->mReadCompletionStatus = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("readProgressMeasure");
        if ($tempVal) {
            $map->mReadProgressMeasure = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("writeRawScore");
        if ($tempVal) {
            $map->mWriteRawScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("writeMinScore");
        if ($tempVal) {
            $map->mWriteMinScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("writeMaxScore");
        if ($tempVal) {
            $map->mWriteMaxScore = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("writeCompletionStatus");
        if ($tempVal) {
            $map->mWriteCompletionStatus = self::convert_to_bool($tempVal);
        }

        $tempVal = $iNode->getAttribute("writeProgressMeasure");
        if ($tempVal) {
            $map->mWriteProgressMeasure = self::convert_to_bool($tempVal);
        }

        return $map;
    }

getADLSeqMaps()

static SeqTreeBuilder::getADLSeqMaps ( object  $iNode, object  $curseqobj  )

static

Definition at line 514 of file SeqTreeBuilder.php.

                                                                          : object
    {
        if (count($curseqobj->mMaps) == null) {
            $curseqobj->mMaps = array();
        }
        $maps = $curseqobj->mMaps;

        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "mapInfo") {
                    $map = new SeqObjectiveMap();
                    $curadltargetobjid = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("targetObjectiveID")));
                    // if the adl map target id matches an imsssssss one, then add to the imsssss one
                    $matchingmapindex = -1;
                    foreach ($maps as $j => $value) {
                        if ($value['_SeqObjectiveMap']->mGlobalObjID == $curadltargetobjid) {
                            $map = $value['_SeqObjectiveMap'];
                            $matchingmapindex = $j;
                        }
                    }
                    // tom: if default access is dependent on map existence then this will need to know if an imsss:mapInfo existed
                    $map = self::fillinADLSeqMaps($curNode, $map);

                    $c_map['_SeqObjectiveMap'] = $map;
                    if ($matchingmapindex > -1) {
                        $maps[$matchingmapindex] = $c_map;
                    } else {
                        $maps[] = $c_map;
                    }
                }
            }
        }
        $curseqobj->mMaps = $maps;
        return $curseqobj;
    }

getADLSEQObjectives()

static SeqTreeBuilder::getADLSEQObjectives ( object  $iNode, object  $ioAct  )

static

Definition at line 474 of file SeqTreeBuilder.php.

References $DIC, $objectives, and ilLoggerFactory\getLogger().

                                                                            : object
    {
        global $DIC;
        $ilLog = ilLoggerFactory::getLogger('sc13');
        $objectives = $ioAct->mObjectives;
        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "objective") {
                    // get the objectiveID
                    $adlseqobjid = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("objectiveID")));

                    // find the imsss objective with the same objectiveID
                    $curseqobj = null;
                    foreach ($objectives as $j => $value) {
                        $seqobj = $value['_SeqObjective'];
                        if ($seqobj->mObjID == $adlseqobjid) {
                            $curseqobj = $seqobj;
                            $curseqobjindex = $j;
                            break;
                        }
                    }

                    // if there's a current seq then let's add the maps
                    if ($curseqobj != null) {
                        //  for each adlseq map info populate that mMaps with map info in the adlseq objective
                        $curseqobj = self::getADLSeqMaps($curNode, $curseqobj);
                        $seqobj = $curseqobj;
                        $objectives[$curseqobjindex]['_SeqObjective'] = $seqobj;
                    }
                }
            }
        }
        // before i leave what do i have to duplicate in SeqActivity or some other class?
        // prolly just
        $ioAct->setObjectives($objectives);
        return $ioAct;
    }

Here is the call graph for this function:

getAuxResources()

static SeqTreeBuilder::getAuxResources ( object  $iNode, object  $ioAct  )

static

Definition at line 926 of file SeqTreeBuilder.php.

References $res.

                                                                        : object
    {
        $ok = true;
        $tempVal = null;
        $auxRes = array();
        //get children
        $children = $iNode->childNodes;

        //find  ressources
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "auxiliaryResource") {
                    //found it
                    $res = new ADLAuxiliaryResource();

                    // Get the resource's purpose
                    $tempVal = $curNode->getAttribute("purpose");
                    if ($tempVal) {
                        $res->mType = $tempVal;
                    }
                    // Get the resource's ID
                    $tempVal = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("auxiliaryResourceID")));
                    if ($tempVal) {
                        $res->mResourceID = $tempVal;
                    }
                    $auxRes[] = $res;
                }
            }
        }
        //add class
        $c_auxRes['_ADLAuxiliaryResource'] = $auxRes;
        $ioAct->setAuxResources($c_auxRes);
        return $ioAct;
    }

getObjectiveMaps()

static SeqTreeBuilder::getObjectiveMaps ( object  $iNode )

static

Definition at line 611 of file SeqTreeBuilder.php.

                                                          : ?array
    {
        $tempVal = null;
        $maps = array();
        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "mapInfo") {
                    $map = new SeqObjectiveMap();

                    // Look for 'targetObjectiveID'
                    $tempVal = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("targetObjectiveID")));
                    if ($tempVal) {
                        $map->mGlobalObjID = $tempVal;
                    }

                    // Look for 'readSatisfiedStatus'
                    $tempVal = $curNode->getAttribute("readSatisfiedStatus");
                    if ($tempVal) {
                        $map->mReadStatus = self::convert_to_bool($tempVal);
                    }

                    // Look for 'readNormalizedMeasure'
                    $tempVal = $curNode->getAttribute("readNormalizedMeasure");
                    if ($tempVal) {
                        $map->mReadMeasure = self::convert_to_bool($tempVal);
                    }

                    // Look for 'writeSatisfiedStatus'
                    $tempVal = $curNode->getAttribute("writeSatisfiedStatus");
                    if ($tempVal) {
                        $map->mWriteStatus = self::convert_to_bool($tempVal);
                    }

                    // Look for 'writeNormalizedMeasure'
                    $tempVal = $curNode->getAttribute("writeNormalizedMeasure");
                    if ($tempVal) {
                        $map->mWriteMeasure = self::convert_to_bool($tempVal);
                    }
                    //add class
                    $c_map['_SeqObjectiveMap'] = $map;
                    $maps[] = $c_map;
                }
            }
        }
        if (count($maps) == null) {
            $maps = null;
        }
        return $maps;
    }

getObjectives()

static SeqTreeBuilder::getObjectives ( object  $iNode, object  $ioAct  )

static

Definition at line 422 of file SeqTreeBuilder.php.

References $DIC, $objectives, and ilLoggerFactory\getLogger().

                                                                      : object
    {
        global $DIC;
        $ilLog = ilLoggerFactory::getLogger('sc13');


        $ok = true;
        $tempVal = null;
        $objectives = array();
        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "primaryObjective" || $curNode->localName === "objective") {
                    $obj = new SeqObjective();
                    if ($curNode->localName === "primaryObjective") {
                        $obj->mContributesToRollup = true;
                    }

                    // Look for 'objectiveID'
                    $tempVal = preg_replace('/(%20)+/', ' ', trim($curNode->getAttribute("objectiveID")));
                    if ($tempVal) {
                        $obj->mObjID = $tempVal;
                    }

                    // Look for 'satisfiedByMeasure'
                    $tempVal = $curNode->getAttribute("satisfiedByMeasure");
                    if ($tempVal) {
                        $obj->mSatisfiedByMeasure = self::convert_to_bool($tempVal);
                    }
                    // Look for 'minNormalizedMeasure'
                    $tempVal = self::lookupElement($curNode, "minNormalizedMeasure");
                    if ($tempVal) {
                        $obj->mMinMeasure = (float) $tempVal;
                    }

                    //get ObjectiveMaps
                    $maps = self::getObjectiveMaps($curNode);
                    if ($maps != null) {
                        $obj->mMaps = $maps;
                    }
                    //$obj->mContributesToRollup = true;
                    //add class
                    $c_obj['_SeqObjective'] = $obj;
                    $objectives[] = $c_obj;
                }
            }
        }
        $ioAct->setObjectives($objectives);
        return $ioAct;
    }

Here is the call graph for this function:

getRollupRules()

static SeqTreeBuilder::getRollupRules ( object  $iNode, object  $ioAct  )

static

Definition at line 663 of file SeqTreeBuilder.php.

References COMBINATION_ANY.

                                                                       : object
    {
        $ok = true;
        $tempVal = null;
        $rollupRules = array();

        // Look for 'rollupObjectiveSatisfied'
        $tempVal = $iNode->getAttribute("rollupObjectiveSatisfied");
        if ($tempVal) {
            $ioAct->setIsObjRolledUp(self::convert_to_bool($tempVal));
        }

        // Look for 'objectiveMeasureWeight'
        $tempVal = $iNode->getAttribute("objectiveMeasureWeight");
        if ($tempVal) {
            $ioAct->setObjMeasureWeight((float)$tempVal);
        }
        // Look for 'rollupProgressCompletion'
        $tempVal = $iNode->getAttribute("rollupProgressCompletion");
        if ($tempVal) {
            $ioAct->setIsProgressRolledUp(self::convert_to_bool($tempVal));
        }
        $children = $iNode->childNodes;
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "rollupRule") {
                    $rule = new SeqRollupRule();

                    // Look for 'childActivitySet'
                    $tempVal = $curNode->getAttribute("childActivitySet");
                    if ($tempVal) {
                        $rule->mChildActivitySet = $tempVal;
                    }
                    // Look for 'minimumCount'
                    $tempVal = $curNode->getAttribute("minimumCount");
                    if ($tempVal) {
                        $rule->mMinCount = $tempVal;
                    }

                    // Look for 'minimumPercent'
                    $tempVal = $curNode->getAttribute("minimumPercent");
                    if ($tempVal) {
                        $rule->mMinPercent = $tempVal;
                    }
                    $rule->mConditions['_SeqConditionSet'] = new SeqConditionSet(true);
                    $conditions = array();
                    $ruleInfo = $curNode->childNodes;
                    for ($j = 0; $j < $ruleInfo->length; $j++) {
                        $curRule = $ruleInfo->item($j);
                        //check for element
                        if ($curRule->nodeType == XML_ELEMENT_NODE) {
                            if ($curRule->localName === "rollupConditions") {
                                $tempVal = $curRule->getAttribute("conditionCombination");
                                if ($tempVal) {
                                    $rule->mConditions['_SeqConditionSet']->mCombination = $tempVal;
                                } else {
                                    $rule->mConditions['_SeqConditionSet']->mCombination = COMBINATION_ANY;
                                }
                                $conds = $curRule->childNodes;
                                for ($k = 0; $k < $conds->length; $k++) {
                                    $con = $conds->item($k);
                                    if ($con->nodeType == XML_ELEMENT_NODE) {
                                        if ($con->localName === "rollupCondition") {
                                            $cond = new SeqCondition();
                                            // Look for 'condition'
                                            $tempVal = $con->getAttribute("condition");
                                            if ($tempVal) {
                                                $cond->mCondition = $tempVal;
                                            }
                                            // Look for 'operator'
                                            $tempVal = $con->getAttribute("operator");
                                            if ($tempVal) {
                                                if ($tempVal === 'not') {
                                                    $cond->mNot = true;
                                                } else {
                                                    $cond->mNot = false;
                                                }
                                            }
                                            //add class
                                            $c_cond['_SeqCondition'] = $cond;
                                            $conditions[] = $c_cond;
                                        }
                                    }
                                }
                            } elseif ($curRule->localName === "rollupAction") {
                                $tempVal = $curRule->getAttribute("action");
                                if ($tempVal) {
                                    $rule->setRollupAction($tempVal);
                                }
                            }
                        }
                    }
                    // Add the conditions to the condition set for the rule
                    $rule->mConditions['_SeqConditionSet']->mConditions = $conditions;

                    // Add the rule to the ruleset
                    //add class
                    $c_rule['_SeqRollupRule'] = $rule;
                    $rollupRules[] = $c_rule;
                }
            }
        }

        if ($rollupRules != null) {
            $rules = new SeqRollupRuleset($rollupRules);
            // Set the Activity's rollup rules
            //add class
            $c_rules['_SeqRollupRuleset'] = $rules;
            $ioAct->setRollupRules($c_rules);
        }

        return $ioAct;
    }

getSequencingRules()

static SeqTreeBuilder::getSequencingRules ( object  $iNode, object  $ioAct  )

static

Definition at line 779 of file SeqTreeBuilder.php.

                                                                           : object
    {
        //local variables
        $ok = true;
        $tempVal = null;

        $preRules = array();
        $exitRules = array();
        $postRules = array();

        //get children
        $children = $iNode->childNodes;

        //find sequencing rules
        for ($i = 0; $i < $children->length; $i++) {
            $curNode = $children->item($i);
            if ($curNode->nodeType == XML_ELEMENT_NODE) {
                if ($curNode->localName === "preConditionRule" || $curNode->localName === "exitConditionRule" || $curNode->localName === "postConditionRule") {
                    $rule = new SeqRule();
                    $ruleInfo = $curNode->childNodes;
                    for ($j = 0; $j < $ruleInfo->length; $j++) {
                        $curRule = $ruleInfo->item($j);
                        //echo "$curRule->localName\n";
                        if ($curRule->nodeType == XML_ELEMENT_NODE) {
                            if ($curRule->localName === "ruleConditions") {
                                $rule->mConditions = self::extractSeqRuleConditions($curRule);
                            } elseif ($curRule->localName === "ruleAction") {
                                $tempVal = $curRule->getAttribute("action");
                                if ($tempVal) {
                                    $rule->mAction = $tempVal;
                                }
                            }
                        }
                    }//end for inner
                    if ($rule->mConditions != null && $rule->mAction != null) {
                        //changed from ADL Code..
                        if ($curNode->localName === "preConditionRule") {
                            //echo "ADD PRE";
                            //add class
                            $c_rule['_SeqRule'] = $rule;
                            $preRules[] = $c_rule;
                        }
                        if ($curNode->localName === "exitConditionRule") {
                            //echo "ADD EXIT";
                            //add class
                            $c_rule['_SeqRule'] = $rule;
                            $exitRules[] = $c_rule;
                        }
                        if ($curNode->localName === "postConditionRule") {
                            //echo "ADD POST";
                            //add class
                            $c_rule['_SeqRule'] = $rule;
                            $postRules[] = $c_rule;
                        }
                    }
                } //end if preCondition
            }  //end if ELEMENT
        }

        if (count($preRules) > 0) {
            $rules = new SeqRuleset($preRules);
            //add class
            $c_rules['_SeqRuleset'] = $rules;
            $ioAct->setPreSeqRules($c_rules);
        }

        if (count($exitRules) > 0) {
            $rules = new SeqRuleset($exitRules);
            //add class
            $c_rules['_SeqRuleset'] = $rules;
            $ioAct->setExitSeqRules($c_rules);
        }
        if (count($postRules) > 0) {
            $rules = new SeqRuleset($postRules);
            //add class
            $c_rules['_SeqRuleset'] = $rules;
            $ioAct->setPostSeqRules($c_rules);
        }
        //echo json_encode($ioAct);

        return $ioAct;
    }

lookupElement()

static SeqTreeBuilder::lookupElement ( object  $iNode, ?string  $iElement  )

staticprivate

Definition at line 970 of file SeqTreeBuilder.php.

                                                                           : ?string
    {
        $value = null;
        $curNode = null;
        $children = null;

        if ($iNode != null && $iElement != null) {
            $children = $iNode->childNodes;
            for ($i = 0; $i < $children->length; $i++) {
                $curNode = $children->item($i);
                if (($curNode->nodeType == XML_ELEMENT_NODE)) {
                    if ($curNode->localName == $iElement) {
                        break;
                    }
                }
            }
            if ($curNode != null) {
                $comp = $curNode->localName;
                if ($comp != null) {
                    if ($comp != $iElement) {
                        $curNode = null;
                    }
                } else {
                    $curNode = null;
                }
            }
        } else {
            //$iElement is null
            $curNode = $iNode;
        }

        if ($curNode != null) {
            $children = $curNode->childNodes;
            if ($children != null) {
                for ($i = 0; $i < $children->length; $i++) {
                    $curNode = $children->item($i);
                    // make sure we have a 'text' element
                    if (($curNode->nodeType == XML_TEXT_NODE) || ($curNode->nodeType == XML_CDATA_SECTION_NODE)) {
                        $value = $value . $curNode->nodeValue;
                    }
                }
            }
        }
        return $value;
    }

---

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

• Modules/Scorm2004/classes/adlparser/SeqTreeBuilder.php