ILIAS\MediaObjects\SubTitles\Retrieval Class Reference

Inheritance diagram for ILIAS\MediaObjects\SubTitles\Retrieval:

Collaboration diagram for ILIAS\MediaObjects\SubTitles\Retrieval:

Public Member Functions
	__construct (protected \ilObjMediaObject $media_object)
	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 ()

Protected Attributes
array	$data = null

Detailed Description

Definition at line 28 of file Retrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MediaObjects\SubTitles\Retrieval::__construct

(

protected \ilObjMediaObject

$media_object

)

Definition at line 34 of file Retrieval.php.

      {
    }

Member Function Documentation

collectData()

ILIAS\MediaObjects\SubTitles\Retrieval::collectData ( )

protected

Definition at line 65 of file Retrieval.php.

                                    : array
    {
        if ($this->data !== null) {
            return $this->data;
        }
 
        $data = [];
        foreach ($this->media_object->getSrtFiles() as $file) {
            $data[] = [
                "id" => (string) $file["file"],
                "file" => (string) $file["full_path"],
                "language" => (string) $file["language"]
            ];
        }
 
        return $this->data = $data;
    }

References $data.

count()

ILIAS\MediaObjects\SubTitles\Retrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 53 of file Retrieval.php.

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

getData()

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

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 39 of file Retrieval.php.

     : \Generator {
        $data = $this->collectData();
        $data = $this->applyOrder($data, $order);
        $data = $this->applyRange($data, $range);
 
        yield from $data;
    }

isFieldNumeric()

ILIAS\MediaObjects\SubTitles\Retrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 60 of file Retrieval.php.

                                                 : bool
    {
        return false;
    }

Field Documentation

$data

array ILIAS\MediaObjects\SubTitles\Retrieval::$data = null

protected

Definition at line 32 of file Retrieval.php.

---

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

• components/ILIAS/MediaObjects/SubTitles/Retrieval.php