ILIAS\LearningModule\Editing\SubObjectRetrieval Class Reference

Inheritance diagram for ILIAS\LearningModule\Editing\SubObjectRetrieval:

Collaboration diagram for ILIAS\LearningModule\Editing\SubObjectRetrieval:

Public Member Functions
	__construct (protected \ilLMTree $lm_tree, protected $type="", protected $current_node=0, protected $transl="")
	getChildTitle (array $child)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)

Protected Member Functions
	getChilds ()

Protected Attributes
ilLanguage	$lng
ILIAS UI Factory	$f
array	$childs = null

Detailed Description

Definition at line 27 of file SubObjectRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LearningModule\Editing\SubObjectRetrieval::__construct	(	protected \ilLMTree	$lm_tree,
		protected	$type = "",
		protected	$current_node = 0,
		protected	$transl = ""
	)

Definition at line 33 of file SubObjectRetrieval.php.

References $DIC, and ILIAS\Repository\lng().

      {
        global $DIC;
        $this->f = $DIC->ui()->factory();
        $this->lng = $DIC->language();
    }

Here is the call graph for this function:

Member Function Documentation

count()

ILIAS\LearningModule\Editing\SubObjectRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 110 of file SubObjectRetrieval.php.

References ILIAS\LearningModule\Editing\SubObjectRetrieval\getChilds().

     : int {
        return count($this->getChilds());
    }

Here is the call graph for this function:

getChilds()

ILIAS\LearningModule\Editing\SubObjectRetrieval::getChilds ( )

protected

Definition at line 53 of file SubObjectRetrieval.php.

References ILIAS\LearningModule\Editing\SubObjectRetrieval\$childs.

Referenced by ILIAS\LearningModule\Editing\SubObjectRetrieval\count(), and ILIAS\LearningModule\Editing\SubObjectRetrieval\getData().

                                  : array
    {
        $current_node = ($this->current_node > 0)
            ? $this->current_node
            : $this->lm_tree->readRootId();
        if (is_null($this->childs)) {
            $this->childs = $this->lm_tree->getChildsByType($current_node, $this->type);
        }
        return $this->childs;
    }

Here is the caller graph for this function:

getChildTitle()

ILIAS\LearningModule\Editing\SubObjectRetrieval::getChildTitle

(

array

$child

)

Definition at line 44 of file SubObjectRetrieval.php.

Referenced by ILIAS\LearningModule\Editing\SubObjectRetrieval\getData().

                                               : string
    {
        if (!in_array($this->transl, ["-", ""])) {
            $lmobjtrans = new \ilLMObjTranslation($child["child"], $this->transl);
            return $lmobjtrans->getTitle();
        }
        return $child["title"];
    }

Here is the caller graph for this function:

getData()

ILIAS\LearningModule\Editing\SubObjectRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 64 of file SubObjectRetrieval.php.

References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), ILIAS\LearningModule\Editing\SubObjectRetrieval\getChilds(), and ILIAS\LearningModule\Editing\SubObjectRetrieval\getChildTitle().

     : \Generator {
        foreach ($this->getChilds() as $child) {
            $active = true;
            $scheduled = false;
            $deactivated_elements = false;
            if ($child["type"] === "pg") {
                // check activation
                $lm_set = new \ilSetting("lm");
                $active = \ilLMPage::_lookupActive(
                    $child["obj_id"],
                    "lm",
                    (bool) $lm_set->get("time_scheduled_page_activation")
                );

                // is page scheduled?
                $scheduled = ((bool) $lm_set->get("time_scheduled_page_activation") &&
                    \ilLMPage::_isScheduledActivation($child["obj_id"], "lm"));
                if ($active) {
                    $deactivated_elements = (\ilLMPage::_lookupContainsDeactivatedElements(
                        $child["obj_id"],
                        "lm"
                    ));
                }
            }
            $trans_title = "";
            if (!in_array($this->transl, ["-", ""])) {
                $trans_title = $this->getChildTitle($child);
            }
            yield [
                "id" => $child["child"],
                "deactivated_elements" => $deactivated_elements,
                "active" => $active,
                "scheduled" => $scheduled,
                "type" => $child["type"],
                "title" => $child["title"],
                "trans_title" => $trans_title
            ];
        }
    }

Here is the call graph for this function:

isFieldNumeric()

ILIAS\LearningModule\Editing\SubObjectRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 117 of file SubObjectRetrieval.php.

                                                 : bool
    {
        return $field === "id";
    }

Field Documentation

$childs

array ILIAS\LearningModule\Editing\SubObjectRetrieval::$childs = null

protected

Definition at line 31 of file SubObjectRetrieval.php.

Referenced by ILIAS\LearningModule\Editing\SubObjectRetrieval\getChilds().

$f

ILIAS UI Factory ILIAS\LearningModule\Editing\SubObjectRetrieval::$f

protected

Definition at line 30 of file SubObjectRetrieval.php.

$lng

ilLanguage ILIAS\LearningModule\Editing\SubObjectRetrieval::$lng

protected

Definition at line 29 of file SubObjectRetrieval.php.

---

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

• components/ILIAS/LearningModule/Editing/SubObjectRetrieval.php