Builds data types. More...

Inheritance diagram for ILIAS\Data\Factory:

Collaboration diagram for ILIAS\Data\Factory:

Public Member Functions
	ok ($value)
	Get an ok result. More...

	error ($e)
	Get an error result. More...

	color ($value)
	Color is a data type representing a color in HTML. More...

	uri (string $uri_string)
	Object representing an uri valid according to RFC 3986 with restrictions imposed on valid characters and obliagtory parts. More...

	dataSize ($size, ?string $unit=null)
	Represents the size of some data. More...

	password (string $pass)

	clientId (string $clientId)

	refId (int $ref_id)

	objId (int $obj_id)

	alphanumeric ($value)

	positiveInteger (int $value)

	dateFormat ()

	range (int $start, int $length)

	order (string $subject, string $direction)

	version (string $version)

	link (string $label, URI $url)

	clock ()

	dimension ()

	dataset (array $dimensions, array $dimension_groups=[])

	htmlMetadata ()

	openGraphMetadata ()

	languageTag (string $language_tag)

	text ()

	emailAddress (string $address)

	description ()

Private Attributes
Color Factory	$colorfactory = null

Dimension Factory	$dimensionfactory = null

Meta Html Factory	$html_metadata_factory = null

Meta Html OpenGraph Factory	$open_graph_metadata_factory = null

Text Factory	$text_factory = null

Description Factory	$description_factory = null

Detailed Description

Builds data types.

Author: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 35 of file Factory.php.

Member Function Documentation

◆ alphanumeric()

ILIAS\Data\Factory::alphanumeric ( $value )

Parameters

mixed $value

Definition at line 138 of file Factory.php.

                                        : Alphanumeric
    {
        return new Alphanumeric($value);
    }

◆ clientId()

ILIAS\Data\Factory::clientId ( string $clientId )

Definition at line 120 of file Factory.php.

                                              : ClientId
    {
        return new ClientId($clientId);
    }

References $clientId.

◆ clock()

ILIAS\Data\Factory::clock ( )

Definition at line 181 of file Factory.php.

                           : ClockFactory
    {
        return new ClockFactoryImpl();
    }

◆ color()

ILIAS\Data\Factory::color ( $value )

Color is a data type representing a color in HTML.

Construct a color with a hex-value or list of RGB-values.

Parameters

string | int[] $value

Definition at line 72 of file Factory.php.

                                 : Color
    {
        if (!$this->colorfactory) {
            $this->colorfactory = new Color\Factory();
        }
        return $this->colorfactory->build($value);
    }

◆ dataset()

ILIAS\Data\Factory::dataset	(	array	$dimensions,
		array	$dimension_groups = `[]`
	)

Parameters

array<string,Dimension

Dimension> $dimensions Dimensions with their names as keys

Parameters

array<string,Dimension

DimensionGroup> $dimension_groups

Definition at line 198 of file Factory.php.

                                                                            : Chart\Dataset
    {
        return new Chart\Dataset($dimensions, $dimension_groups);
    }

◆ dataSize()

ILIAS\Data\Factory::dataSize	(		$size,
		?string	$unit = `null`
	)

Represents the size of some data.

Parameters

string | int $size string might be a string like "126 MB"

Exceptions

InvalidArgumentException if first argument is int and second is not a valid unit.

Exceptions

InvalidArgumentException if string size can't be interpreted

Definition at line 97 of file Factory.php.

                                                         : DataSize
    {
        if (is_string($size)) {
            $match = [];
            if (!preg_match("/(\d+)\s*([a-zA-Z]+)/", $size, $match)) {
                throw new \InvalidArgumentException("'$size' can't be interpreted as data size.");
            }
            return $this->dataSize((int) $match[1], $match[2]);
        }
        if (is_int($size) && (is_null($unit) || !array_key_exists($unit, DataSize::$abbreviations))) {
            throw new \InvalidArgumentException(
                "Expected second argument to be a unit for data, '$unit' is unknown."
            );
        }
        $unit_size = DataSize::$abbreviations[$unit];
        return new DataSize($size * $unit_size, $unit_size);
    }

References ILIAS\Data\DataSize\$abbreviations, and ILIAS\Data\Factory\dataSize().

Referenced by ILIAS\Data\Factory\dataSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dateFormat()

ILIAS\Data\Factory::dateFormat ( )

Definition at line 148 of file Factory.php.

                                : DateFormat\Factory
    {
        $builder = new DateFormat\FormatBuilder();
        return new DateFormat\Factory($builder);
    }

◆ description()

ILIAS\Data\Factory::description ( )

Definition at line 245 of file Factory.php.

                                 : Description\Factory
    {
        if ($this->description_factory === null) {
            $this->description_factory = new Description\Factory();
        }
        return $this->description_factory;
    }

References ILIAS\Data\Factory\$description_factory.

◆ dimension()

ILIAS\Data\Factory::dimension ( )

Definition at line 186 of file Factory.php.

                               : Dimension\Factory
    {
        if (!$this->dimensionfactory) {
            $this->dimensionfactory = new Dimension\Factory();
        }
        return $this->dimensionfactory;
    }

References ILIAS\Data\Factory\$dimensionfactory.

◆ emailAddress()

ILIAS\Data\Factory::emailAddress ( string $address )

Definition at line 240 of file Factory.php.

                                                 : EmailAddress
    {
        return new EmailAddress($address);
    }

◆ error()

ILIAS\Data\Factory::error ( $e )

Get an error result.

Parameters

string | \Exception $e

Returns: Result

Definition at line 61 of file Factory.php.

                             : Result
    {
        return new Result\Error($e);
    }

References Vendor\Package\$e.

◆ htmlMetadata()

ILIAS\Data\Factory::htmlMetadata ( )

Definition at line 203 of file Factory.php.

                                  : Meta\Html\Factory
    {
        if (null === $this->html_metadata_factory) {
            $this->html_metadata_factory = new Meta\Html\Factory();
        }
 
        return $this->html_metadata_factory;
    }

References ILIAS\Data\Factory\$html_metadata_factory.

◆ languageTag()

ILIAS\Data\Factory::languageTag ( string $language_tag )

Definition at line 221 of file Factory.php.

                                                     : LanguageTag
    {
        return LanguageTag::fromString($language_tag);
    }

References ILIAS\Data\LanguageTag\fromString().

Here is the call graph for this function:

◆ link()

ILIAS\Data\Factory::link	(	string	$label,
		URI	$url
	)

Definition at line 176 of file Factory.php.

                                                 : Link
    {
        return new Link($label, $url);
    }

References $url.

◆ objId()

ILIAS\Data\Factory::objId ( int $obj_id )

Definition at line 130 of file Factory.php.

                                      : ObjectId
    {
        return new ObjectId($obj_id);
    }

◆ ok()

ILIAS\Data\Factory::ok ( $value )

Get an ok result.

Parameters

mixed $value

Definition at line 50 of file Factory.php.

                              : Result
    {
        return new Result\Ok($value);
    }

◆ openGraphMetadata()

ILIAS\Data\Factory::openGraphMetadata ( )

Definition at line 212 of file Factory.php.

                                       : Meta\Html\OpenGraph\Factory
    {
        if (null === $this->open_graph_metadata_factory) {
            $this->open_graph_metadata_factory = new Meta\Html\OpenGraph\Factory();
        }
 
        return $this->open_graph_metadata_factory;
    }

References ILIAS\Data\Factory\$open_graph_metadata_factory.

◆ order()

ILIAS\Data\Factory::order	(	string	$subject,
		string	$direction
	)

Parameters

string $direction Order::ASC|Order::DESC

Definition at line 162 of file Factory.php.

                                                             : Order
    {
        return new Order($subject, $direction);
    }

◆ password()

ILIAS\Data\Factory::password ( string $pass )

Definition at line 115 of file Factory.php.

                                          : Password
    {
        return new Password($pass);
    }

References ILIAS\User\Settings\Password.

◆ positiveInteger()

ILIAS\Data\Factory::positiveInteger ( int $value )

Definition at line 143 of file Factory.php.

                                               : PositiveInteger
    {
        return new PositiveInteger($value);
    }

◆ range()

ILIAS\Data\Factory::range	(	int	$start,
		int	$length
	)

Definition at line 154 of file Factory.php.

                                                  : Range
    {
        return new Range($start, $length);
    }

◆ refId()

ILIAS\Data\Factory::refId ( int $ref_id )

Definition at line 125 of file Factory.php.

                                      : ReferenceId
    {
        return new ReferenceId($ref_id);
    }

References $ref_id.

◆ text()

ILIAS\Data\Factory::text ( )

Definition at line 226 of file Factory.php.

                          : Text\Factory
    {
        if ($this->text_factory === null) {
            $md_format = new \ILIAS\Refinery\String\MarkdownFormattingToHTML();
            $this->text_factory = new \ILIAS\Data\Text\Factory(
                new Text\MarkdownFactory(
                    new Text\Shape\Markdown($md_format),
                    new Text\Shape\SimpleDocumentMarkdown($md_format),
                    new Text\Shape\WordOnlyMarkdown($md_format)
                )
            );
        }
        return $this->text_factory;
    }

References ILIAS\Data\Factory\$text_factory.

◆ uri()

ILIAS\Data\Factory::uri ( string $uri_string )

Object representing an uri valid according to RFC 3986 with restrictions imposed on valid characters and obliagtory parts.

Definition at line 85 of file Factory.php.

                                           : URI
    {
        return new URI($uri_string);
    }

◆ version()

ILIAS\Data\Factory::version ( string $version )

Parameters

string $version in the form \d+([.]\d+([.]\d+)?)?

Exceptions

InvalidArgumentException if version string does not match \d+([.]\d+([.]\d+)?)?

Definition at line 171 of file Factory.php.

                                            : Version
    {
        return new Version($version);
    }

References $version.

Field Documentation

◆ $colorfactory

Color Factory ILIAS\Data\Factory::$colorfactory = null

private

Definition at line 38 of file Factory.php.

◆ $description_factory

Description Factory ILIAS\Data\Factory::$description_factory = null

private

Definition at line 43 of file Factory.php.

Referenced by ILIAS\Data\Factory\description().

◆ $dimensionfactory

Dimension Factory ILIAS\Data\Factory::$dimensionfactory = null

private

Definition at line 39 of file Factory.php.

Referenced by ILIAS\Data\Factory\dimension().

◆ $html_metadata_factory

Meta Html Factory ILIAS\Data\Factory::$html_metadata_factory = null

private

Definition at line 40 of file Factory.php.

Referenced by ILIAS\Data\Factory\htmlMetadata().

◆ $open_graph_metadata_factory

Meta Html OpenGraph Factory ILIAS\Data\Factory::$open_graph_metadata_factory = null

private

Definition at line 41 of file Factory.php.

Referenced by ILIAS\Data\Factory\openGraphMetadata().

◆ $text_factory

Text Factory ILIAS\Data\Factory::$text_factory = null

private

Definition at line 42 of file Factory.php.

Referenced by ILIAS\Data\Factory\text().

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

components/ILIAS/Data/src/Factory.php

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ alphanumeric()

◆ clientId()

◆ clock()

◆ color()

◆ dataset()

◆ dataSize()

◆ dateFormat()

◆ description()

◆ dimension()

◆ emailAddress()

◆ error()

◆ htmlMetadata()

◆ languageTag()

◆ link()

◆ objId()

◆ ok()

◆ openGraphMetadata()

◆ order()

◆ password()

◆ positiveInteger()

◆ range()

◆ refId()

◆ text()

◆ uri()

◆ version()

Field Documentation

◆ $colorfactory

◆ $description_factory

◆ $dimensionfactory

◆ $html_metadata_factory

◆ $open_graph_metadata_factory

◆ $text_factory