ILIAS\PersonalWorkspace\WorkspaceShareRetrieval Class Reference

Inheritance diagram for ILIAS\PersonalWorkspace\WorkspaceShareRetrieval:

Collaboration diagram for ILIAS\PersonalWorkspace\WorkspaceShareRetrieval:

Public Member Functions
	__construct (protected \ilWorkspaceAccessHandler|\ilPortfolioAccessHandler $handler, protected bool $portfolio_mode, protected array $crs_ids, protected array $grp_ids, protected \ilLanguage $lng)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter, array $parameters)
	isFieldNumeric (string $field)

Protected Member Functions
	collectData (array $filter)
	normalizeFilter (array $filter)

Detailed Description

Definition at line 28 of file WorkspaceShareRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\PersonalWorkspace\WorkspaceShareRetrieval::__construct	(	protected \ilWorkspaceAccessHandler|\ilPortfolioAccessHandler	$handler,
		protected bool	$portfolio_mode,
		protected array	$crs_ids,
		protected array	$grp_ids,
		protected \ilLanguage	$lng
	)

Definition at line 32 of file WorkspaceShareRetrieval.php.

      {
    }

Member Function Documentation

collectData()

ILIAS\PersonalWorkspace\WorkspaceShareRetrieval::collectData ( array  $filter )

protected

Definition at line 73 of file WorkspaceShareRetrieval.php.

                                                 : array
    {
        $filter = $this->normalizeFilter($filter);
        $objects = $this->handler->findSharedObjects($filter, $this->crs_ids, $this->grp_ids);
        if (!is_array($objects)) {
            return [];
        }
        $user_data = [];
        $data = [];
 
        foreach ($objects as $wsp_id => $item) {
            $owner_id = (int) $item["owner"];
            if (!isset($user_data[$owner_id])) {
                $user_data[$owner_id] = \ilObjUser::_lookupName($owner_id);
            }
            if (($user_data[$owner_id]["login"] ?? "") === "") {
                continue;
            }
 
            $type = (string) ($item["type"] ?? "");
            $data[] = [
                "id" => $this->portfolio_mode
                    ? $owner_id . "_" . (int) $item["obj_id"]
                    : (string) $wsp_id,
                "wsp_id" => (int) $wsp_id,
                "obj_id" => (int) $item["obj_id"],
                "type" => $type,
                "obj_type" => $this->lng->txt("wsp_type_" . $type),
                "title" => (string) $item["title"],
                "owner_id" => $owner_id,
                "lastname" => (string) $user_data[$owner_id]["lastname"],
                "firstname" => (string) $user_data[$owner_id]["firstname"],
                "login" => (string) $user_data[$owner_id]["login"],
                "acl_type" => $item["acl_type"],
                "acl_date" => (int) $item["acl_date"]
            ];
        }
 
        return $data;
    }

References $data, ilObjUser\_lookupName(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Here is the call graph for this function:

count()

ILIAS\PersonalWorkspace\WorkspaceShareRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 61 of file WorkspaceShareRetrieval.php.

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

getData()

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

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 41 of file WorkspaceShareRetrieval.php.

     : \Generator {
        $data = $this->collectData($filter);
        if ($order === null) {
            $data = array_reverse($data);
        } else {
            $data = $this->applyOrder($data, $order);
        }
        $data = $this->applyRange($data, $range);
 
        foreach ($data as $row) {
            yield $row;
        }
    }

References $data.

isFieldNumeric()

ILIAS\PersonalWorkspace\WorkspaceShareRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 68 of file WorkspaceShareRetrieval.php.

                                                 : bool
    {
        return in_array($field, ["wsp_id", "obj_id", "owner_id", "acl_date"], true);
    }

normalizeFilter()

ILIAS\PersonalWorkspace\WorkspaceShareRetrieval::normalizeFilter ( array  $filter )

protected

Definition at line 114 of file WorkspaceShareRetrieval.php.

                                                     : array
    {
        if (isset($filter["acl_date"]) && is_array($filter["acl_date"])) {
            $start = $filter["acl_date"]["start"] ?? null;
            $filter["acl_date"] = $start instanceof \DateTimeInterface
                ? new \ilDateTime($start->format("Y-m-d"), IL_CAL_DATE)
                : null;
        }
 
        return $filter;
    }

References IL_CAL_DATE.

---

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

• components/ILIAS/PersonalWorkspace/WorkspaceShareRetrieval.php