Builds data types. More...

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)

Private Attributes
Color Factory	$colorfactory = null
	cache for color factory. More...

Dimension Factory	$dimensionfactory = 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 20 of file Factory.php.

Member Function Documentation

◆ alphanumeric()

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

Parameters

mixed $value

Definition at line 121 of file Factory.php.

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

◆ clientId()

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

Definition at line 103 of file Factory.php.

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

◆ clock()

ILIAS\Data\Factory::clock ( )

Definition at line 164 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 55 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 )

Parameters

array<string,Dimension

Definition at line 180 of file Factory.php.

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

◆ 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

Definition at line 80 of file Factory.php.

References ILIAS\Data\DataSize\$abbreviations.

                                                         : 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);
     }

◆ dateFormat()

ILIAS\Data\Factory::dateFormat ( )

Definition at line 131 of file Factory.php.

Referenced by ilIndividualAssessmentUserGradingTest\testToFormInput(), ilStudyProgrammeDeadlineSettings\toFormInput(), and ilStudyProgrammeValidityOfAchievedQualificationSettings\toFormInput().

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

Here is the caller graph for this function:

◆ dimension()

ILIAS\Data\Factory::dimension ( )

Definition at line 169 of file Factory.php.

References ILIAS\Data\Factory\$dimensionfactory.

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

◆ error()

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

Get an error result.

Parameters

string | \Exception $e

Returns: Result

Definition at line 44 of file Factory.php.

References Vendor\Package\$e.

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

◆ link()

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

Definition at line 159 of file Factory.php.

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

◆ objId()

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

Definition at line 113 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 33 of file Factory.php.

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

◆ order()

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

Parameters

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

Definition at line 145 of file Factory.php.

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

◆ password()

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

Definition at line 98 of file Factory.php.

Referenced by PasswordContraintsTest\constraintsProvider(), and ILIAS\UI\examples\Input\Field\Password\with_contraints().

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

Here is the caller graph for this function:

◆ positiveInteger()

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

Definition at line 126 of file Factory.php.

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

◆ range()

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

Definition at line 137 of file Factory.php.

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

◆ refId()

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

Definition at line 108 of file Factory.php.

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

◆ 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 68 of file Factory.php.

Referenced by ILIAS\UI\examples\Table\Action\Multi\base(), ILIAS\UI\examples\Table\Action\Single\base(), ILIAS\UI\examples\Table\Action\Standard\base(), and ILIAS\UI\examples\Table\Data\base().

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

Here is the caller graph for this function:

◆ version()

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

Parameters

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

Exceptions

Definition at line 154 of file Factory.php.

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

Field Documentation

◆ $colorfactory

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

private

cache for color factory.

Definition at line 25 of file Factory.php.

◆ $dimensionfactory

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

private

Definition at line 26 of file Factory.php.

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

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

src/Data/Factory.php

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ alphanumeric()

◆ clientId()

◆ clock()

◆ color()

◆ dataset()

◆ dataSize()

◆ dateFormat()

◆ dimension()

◆ error()

◆ link()

◆ objId()

◆ ok()

◆ order()

◆ password()

◆ positiveInteger()

◆ range()

◆ refId()

◆ uri()

◆ version()

Field Documentation

◆ $colorfactory

◆ $dimensionfactory