SeqActivity.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

define("TIMING_ONCE", "once");
define("TIMING_EACHNEW", "onEachNewAttempt");
define("TER_EXITALL", "_EXITALL_");
define("TIMING_NEVER", "never");

class SeqActivity
{
    //It's quite bad design to declare these variables public (should be private), but for later JSON serialization PHP needs this
    //cause json_encode ignores private or protected variables


    //SeqRuleset
    public ?array $mPreConditionRules = null;

    //SeqRuleset
    public ?array $mPostConditionRules = null;

    //SeqRuleset
    public ?array $mExitActionRules = null;

    public ?string $mXML = null;

    public int $mDepth = 0;

    public int $mCount = -1;

    public string $mLearnerID = "_NULL_";

    public ?string $mScopeID = null;

    public ?string $mActivityID = null;

    public ?string $mResourceID = null;

    public ?string $mStateID = null;

    public ?string $mTitle = null;

    public bool $mIsVisible = true;

    public int $mOrder = -1;

    public int $mActiveOrder = -1;

    public bool $mSelected = true;

    //SeqActivity converted to array???
    public ?string $mParent = null;

    public bool $mIsActive = false;

    public bool $mIsSuspended = false;

    //Vector converted to array
    public ?array $mChildren = null;

    //Vector converted to array
    public ?array $mActiveChildren = null;

    public string $mDeliveryMode = "normal";

    public bool $mControl_choice = true;

    public bool $mControl_choiceExit = true;

    public bool $mControl_flow = false;

    public bool $mControl_forwardOnly = false;

    public bool $mConstrainChoice = false;

    public bool $mPreventActivation = false;

    public bool $mUseCurObj = true;

    public bool $mUseCurPro = true;

    public bool $mMaxAttemptControl = false;

    public int $mMaxAttempt = 0;

    public bool $mAttemptAbDurControl = false;

    //ADLDuration
    public ?string $mAttemptAbDur = null;

    public bool $mAttemptExDurControl = false;

    public ?string $mAttemptExDur = null;

    public bool $mActivityAbDurControl = false;

    //ADLDuration
    public ?string $mActivityAbDur = null;

    public bool $mActivityExDurControl = false;

    //ADLDuration
    public ?string $mActivityExDur = null;

    public bool $mBeginTimeControl = false;

    public ?string $mBeginTime = null;

    public bool $mEndTimeControl = false;

    public ?string $mEndTime = null;

    //convert to array?
    public ?string $mAuxResources = null;

    //SeqRollupRuleset
    public ?array $mRollupRules = null;

    public bool $mActiveMeasure = true;

    public string $mRequiredForSatisfied = ROLLUP_CONSIDER_ALWAYS;

    public string $mRequiredForNotSatisfied = ROLLUP_CONSIDER_ALWAYS;

    public string $mRequiredForCompleted = ROLLUP_CONSIDER_ALWAYS;

    public string $mRequiredForIncomplete = ROLLUP_CONSIDER_ALWAYS;

    //convert to array
    public ?array $mObjectives = null;

    //HashTable convert to assosiative array
    public ?array $mObjMaps = null;

    public bool $mIsObjectiveRolledUp = true;

    public float $mObjMeasureWeight = 1.0;

    public bool $mIsProgressRolledUp = true;

    public string $mSelectTiming = "never";

    public bool $mSelectStatus = false;

    public int $mSelectCount = 0;

    public bool $mSelection = false;

    public string $mRandomTiming = "never";

    public bool $mReorder = false;

    public bool $mRandomized = false;

    public bool $mIsTracked = true;

    public bool $mContentSetsCompletion = false;

    public bool $mContentSetsObj = false;

    //ADLTracking
    public ?object $mCurTracking = null;

    //convert to array?
    public ?array $mTracking = null;

    public int $mNumAttempt = 0;

    public int $mNumSCOAttempt = 0;

    //ADLDuration
    public ?string $mActivityAbDur_track = null;

    //ADLDuration
    public ?string $mActivityExDur_track = null;

    public float $mProgressThreshold = 1.0;

    public bool $mProgressDeterminedByMeasure = false;

    public float $mProgressWeight = 1.0;

    public bool $mmActivityExDurControl = false;

    public string $iTiming = "";


    public function __construct()
    {
        //$this->mActiveChildren = array();
    }

    public function addChild(object $ioChild): void
    {
        if ($this->mChildren == null) {
            $this->mChildren = array();
        }
        if ($this->mActiveChildren == null) {
            $this->mActiveChildren = array();
        }

        //set class
        $c_ioChild['_SeqActivity'] = $ioChild;

        //keep both in sync
        $this->mChildren[] = $c_ioChild;
        //array_push($this->mActiveChildren,$c_ioChild);

        //$this->mActiveChildren = $this->mChildren;

        $ioChild->setOrder(count($this->mChildren) - 1);
        $ioChild->setActiveOrder(count($this->mChildren) - 1);

        //set parents on the client
        //$ioChild->setParent($this);
    }

    public function setOrder(int $iOrder): void
    {
        $this->mOrder = $iOrder;
    }

    public function setActiveOrder(int $iOrder): void
    {
        $this->mActiveOrder = $iOrder;
    }

    public function setParent(string $iParent): void
    {
        $this->mParent = $iParent;
    }



    //setters for public vars
    public function setID(string $id): void
    {
        $this->mActivityID = $id;
    }

    public function setResourceID(string $id): void
    {
        $this->mResourceID = $id;
    }

    public function setIsVisible(bool $visible): void
    {
        $this->mIsVisible = $visible;
    }

    public function setCompletionThreshold(float $compThresh): void
    {
        $this->mProgressThreshold = $compThresh;
    }

    public function setCompletedByMeasure(bool $compbm): void
    {
        $this->mProgressDeterminedByMeasure = $compbm;
    }

    public function setProgressWeight(float $progweight): void
    {
        $this->mProgressWeight = $progweight;
    }

    public function setControlModeChoice(bool $choice): void
    {
        $this->mControl_choice = $choice;
    }

    public function setControlModeChoiceExit(bool $choiceExit): void
    {
        $this->mControl_choiceExit = $choiceExit;
    }

    public function setControlModeFlow(bool $flow): void
    {
        $this->mControl_flow = $flow;
    }

    public function setControlForwardOnly(bool $forwardOnly): void
    {
        $this->mControl_forwardOnly = $forwardOnly;
    }

    public function setUseCurObjective(bool $useCurObjective): void
    {
        $this->mUseCurObj = $useCurObjective;
    }

    public function setUseCurProgress(bool $useCurProgress): void
    {
        $this->mUseCurPro = $useCurProgress;
    }

    public function setAttemptLimit(int $value): void
    {
        if ($value >= 0) {
            $this->mMaxAttemptControl = true;
            $this->mMaxAttempt = $value;
        } else {
            $this->mMaxAttemptControl = false;
            $this->mMaxAttempt = -1;
        }
    }

    public function setAttemptAbDur(?string $iDur): void
    {
        if ($iDur != null) {
            $this->mActivityAbDurControl = true;
            //to be implemented
            //convert duration
            //$this->mActivityAbDur = new ADLDuration(ADLDuration.FORMAT_SCHEMA, iDur);
        } else {
            $this->mActivityAbDurControl = false;
        }
    }

    public function setAttemptExDur(?string $iDur): void
    {
        if ($iDur != null) {
            $this->mAttemptExDurControl = true;
            //to be implemented
            // $this->mAttemptExDur = new ADLDuration(ADLDuration.FORMAT_SCHEMA, iDur);
        } else {
            $this->mAttemptExDurControl = false;
        }
    }

    public function setActivityAbDur(?string $iDur): void
    {
        if ($iDur != null) {
            $this->mActivityAbDurControl = true;
            //$this->mActivityAbDur = new ADLDuration(ADLDuration.FORMAT_SCHEMA, iDur);
        } else {
            $this->mActivityAbDurControl = false;
        }
    }

    public function setActivityExDur(?string $iDur): void
    {
        if ($iDur != null) {
            $this->mmActivityExDurControl = true;
            // $this->mmActivityExDur = new ADLDuration(ADLDuration.FORMAT_SCHEMA, iDur);
        } else {
            $this->mmActivityExDurControl = false;
        }
    }

    public function setBeginTimeLimit(?string $iTime): void
    {
        if ($iTime != null) {
            $this->mBeginTimeControl = true;
            $this->mBeginTime = $iTime;
        } else {
            $this->mBeginTimeControl = false;
        }
    }

    public function setEndTimeLimit(?string $iTime): void
    {
        if ($iTime != null) {
            $this->mEndTimeControl = true;
            $this->mEndTime = $iTime;
        } else {
            $this->mEndTimeControl = false;
        }
    }

    public function setRandomTiming(string $iTiming): void
    {
        // Validate vocabulary
        if (!($this->iTiming == TIMING_NEVER ||
                 $this->iTiming == TIMING_ONCE ||
                 $this->iTiming == TIMING_EACHNEW)) {
            $this->mSelectTiming = TIMING_NEVER;
        } else {
            $this->mRandomTiming = $iTiming;
        }
    }

    public function setSelectCount(int $iCount): void
    {
        if ($iCount >= 0) {
            $this->mSelectStatus = true;
            $this->mSelectCount = $iCount;
        } else {
            $this->mSelectStatus = false;
        }
    }

    public function setReorderChildren(bool $iReorder): void
    {
        $this->mReorder = $iReorder;
    }


    public function setSelectionTiming(string $iTiming): void
    {
        // Validate vocabulary
        if (!($this->iTiming == TIMING_NEVER ||
               $this->iTiming == TIMING_ONCE ||
                  $this->iTiming == TIMING_EACHNEW)) {
            $this->mSelectTiming = TIMING_NEVER;
        } else {
            $this->mSelectTiming = $iTiming;
        }
    }

    public function setIsTracked(bool $iTracked): void
    {
        $this->mIsTracked = $iTracked;
    }

    public function setSetCompletion(bool $iSet): void
    {
        $this->mContentSetsCompletion = $iSet;
    }

    public function setSetObjective(bool $iSet): void
    {
        $this->mContentSetsObj = $iSet;
    }

    public function setPreventActivation(bool $iPreventActivation): void
    {
        $this->mPreventActivation = $iPreventActivation;
    }

    public function setConstrainChoice(bool $iConstrainChoice): void
    {
        $this->mConstrainChoice = $iConstrainChoice;
    }

    public function setRequiredForSatisfied(string $iConsider): void
    {
        $this->mRequiredForSatisfied = $iConsider;
    }

    public function setRequiredForNotSatisfied(string $iConsider): void
    {
        $this->mRequiredForNotSatisfied = $iConsider;
    }

    public function setRequiredForCompleted(string $iConsider): void
    {
        $this->mRequiredForCompleted = $iConsider;
    }

    public function setRequiredForIncomplete(string $iConsider): void
    {
        $this->mRequiredForIncomplete = $iConsider;
    }

    public function setSatisfactionIfActive(bool $iActiveMeasure): void
    {
        $this->mActiveMeasure = $iActiveMeasure;
    }

    public function setTitle(string $title): void
    {
        $this->mTitle = $title;
    }

    public function setPreSeqRules(?array $iRuleSet): void
    {
        $this->mPreConditionRules = $iRuleSet;
    }

    public function setExitSeqRules(?array $iRuleSet): void
    {
        $this->mExitActionRules = $iRuleSet;
    }

    public function setPostSeqRules(?array $iRuleSet): void
    {
        $this->mPostConditionRules = $iRuleSet;
    }

    public function setObjectives(array $iObjs): void
    {
        $this->mObjectives = $iObjs;
        foreach ($iObjs as $value) {
            $obj = $value;
            if ($obj['_SeqObjective']->mMaps != null) {
                $index = $obj['_SeqObjective']->mObjID;
                $this->mObjMaps["$index"] = $obj['_SeqObjective']->mMaps;
            }
        }
    }

    public function setIsObjRolledUp(bool $iRolledup): void
    {
        $this->mIsObjectiveRolledUp = $iRolledup;
    }

    public function setObjMeasureWeight(float $iWeight): void
    {
        $this->mObjMeasureWeight = $iWeight;
    }

    public function setIsProgressRolledUp(bool $iRolledup): void
    {
        $this->mIsProgressRolledUp = $iRolledup;
    }

    public function setRollupRules(?array $iRuleSet): void
    {
        $this->mRollupRules = $iRuleSet;
    }

    public function setAuxResources(string $iRes): void
    {
        $this->mAuxResources = $iRes;
    }




    public function getID(): string
    {
        return $this->mActivityID;
    }

    public function getIsVisible(): bool
    {
        return $this->mIsVisible;
    }
}