ILIAS\Data\Factory Class Reference

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 ($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 ($pass)
	Get a password. More...
	clientId (string $clientId)
	refId (int $ref_id)
	alphanumeric ($value)
	positiveInteger (int $value)
	openedIntegerInterval (int $minimum, int $maximum)
	closedIntegerInterval (int $minimum, int $maximum)
	openedFloatInterval (float $minimum, float $maximum)
	closedFloatInterval (float $minimum, float $maximum)
	dateFormat ()

Private Attributes
	$colorfactory
	cache for color factory. More...

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

Member Function Documentation

alphanumeric()

ILIAS\Data\Factory::alphanumeric

(

$value

)

Parameters

$value

Returns

Alphanumeric

Definition at line 135 of file Factory.php.

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

clientId()

ILIAS\Data\Factory::clientId

(

string

$clientId

)

Parameters

string

$clientId

Returns

ClientId

Definition at line 116 of file Factory.php.

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

closedFloatInterval()

ILIAS\Data\Factory::closedFloatInterval	(	float	$minimum,
		float	$maximum
	)

Parameters

float	$minimum
float	$maximum

Returns

ClosedFloatInterval

Definition at line 184 of file Factory.php.

                                                                        : ClosedFloatInterval
    {
        return new ClosedFloatInterval($minimum, $maximum);
    }

closedIntegerInterval()

ILIAS\Data\Factory::closedIntegerInterval	(	int	$minimum,
		int	$maximum
	)

Parameters

int	$minimum
int	$maximum

Returns

ClosedIntegerInterval

Definition at line 164 of file Factory.php.

                                                                      : ClosedIntegerInterval
    {
        return new ClosedIntegerInterval($minimum, $maximum);
    }

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

Returns

Color

Definition at line 55 of file Factory.php.

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

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

References ILIAS\Data\DataSize\$abbreviations, and $size.

                                                         : DataSize
    {
        if (is_string($size)) {
            $match = [];
            if (!preg_match("/(\d+)\s*([a-zA-Z]+)/", $size, $match)) {
                throw \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

(

)

Returns

DateFormat

Definition at line 192 of file Factory.php.

References $builder.

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

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

Here is the caller graph for this function:

error()

ILIAS\Data\Factory::error

(

$e

)

Get an error result.

Parameters

string | \Exception

$error

Returns

Result

Definition at line 43 of file Factory.php.

References Vendor\Package\$e.

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

ok()

ILIAS\Data\Factory::ok

(

$value

)

Get an ok result.

Parameters

mixed

$value

Returns

Result

Definition at line 32 of file Factory.php.

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

openedFloatInterval()

ILIAS\Data\Factory::openedFloatInterval	(	float	$minimum,
		float	$maximum
	)

Parameters

float	$minimum
float	$maximum

Returns

Float

Definition at line 174 of file Factory.php.

                                                                        : OpenedFloatInterval
    {
        return new OpenedFloatInterval($minimum, $maximum);
    }

openedIntegerInterval()

ILIAS\Data\Factory::openedIntegerInterval	(	int	$minimum,
		int	$maximum
	)

Parameters

int	$minimum
int	$maximum

Returns

OpenedIntegerInterval

Definition at line 154 of file Factory.php.

                                                                      : OpenedIntegerInterval
    {
        return new OpenedIntegerInterval($minimum, $maximum);
    }

password()

ILIAS\Data\Factory::password

(

$pass

)

Get a password.

Parameters

string

Returns

Password

Definition at line 107 of file Factory.php.

References $pass.

    {
        return new Password($pass);
    }

positiveInteger()

ILIAS\Data\Factory::positiveInteger

(

int

$value

)

Parameters

int

$value

Returns

PositiveInteger

Definition at line 144 of file Factory.php.

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

refId()

ILIAS\Data\Factory::refId

(

int

$ref_id

)

Parameters

int

$ref_id

Returns

ReferenceId

Definition at line 126 of file Factory.php.

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

uri()

ILIAS\Data\Factory::uri

(

$uri_string

)

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

Parameters

string

$uri_string

Returns

URI

Definition at line 71 of file Factory.php.

    {
        return new URI($uri_string);
    }

Field Documentation

$colorfactory

ILIAS\Data\Factory::$colorfactory

private

cache for color factory.

Definition at line 24 of file Factory.php.

---

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

• src/Data/Factory.php