ILIAS\Refinery\Factory Class Reference

Collaboration diagram for ILIAS\Refinery\Factory:

Public Member Functions
	__construct (\ILIAS\Data\Factory $dataFactory, \ILIAS\Language\Language $language)
	to ()
	Combined validations and transformations for primitive data types that establish a baseline for further constraints and more complex transformations. More...
	kindlyTo ()
	Combined validations and transformations for primitive data types that establish a baseline for further constraints and more complex transformations. More...
	in ()
	Creates a factory object to create a transformation object, that can be used to execute other transformation objects in a desired order. More...
	int ()
	Contains constraints and transformations on numbers. More...
	string ()
	Contains constraints for string. More...
	custom ()
	Contains constraints and transformations for custom functions. More...
	container ()
	Contains constraints for container types (e.g. More...
	password ()
	Contains constraints for password strings. More...
	logical ()
	Contains constraints for logical compositions with other constraints. More...
	null ()
	Contains constraints for null types. More...
	numeric ()
	Contains constraints for numeric data types. More...
	dateTime ()
	Contains transformations for DateTime. More...
	uri ()
	Contains transformations for Data. More...
	encode ()
	byTrying (array $transformations)
	Accepts Transformations and uses first successful one. More...
	random ()
	identity ()
	always ($value)
	executable ()

Protected Member Functions
	loadLanguageModules ()

Private Attributes
ILIAS Data Factory	$dataFactory
ILIAS Language Language	$language

Detailed Description

Definition at line 25 of file Factory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\Factory::__construct	(	\ILIAS\Data\Factory	$dataFactory,
		\ILIAS\Language\Language	$language
	)

Definition at line 30 of file Factory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

    {
        $this->dataFactory = $dataFactory;
        $this->language = $language;
    }

Here is the call graph for this function:

Member Function Documentation

always()

ILIAS\Refinery\Factory::always

(

$value

)

Definition at line 184 of file Factory.php.

                                  : Transformation
    {
        return new ConstantTransformation($value);
    }

byTrying()

ILIAS\Refinery\Factory::byTrying

(

array

$transformations

)

Accepts Transformations and uses first successful one.

Parameters

Transformation[]

$transformations

Definition at line 168 of file Factory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                                                    : ByTrying
    {
        $this->loadLanguageModules();
        return new ByTrying($transformations, $this->dataFactory, $this->language);
    }

Here is the call graph for this function:

container()

ILIAS\Refinery\Factory::container

(

)

Contains constraints for container types (e.g.

arrays)

Definition at line 101 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, and ILIAS\Refinery\Factory\loadLanguageModules().

                               : Container\Group
    {
        $this->loadLanguageModules();
        return new Container\Group($this->dataFactory);
    }

Here is the call graph for this function:

custom()

ILIAS\Refinery\Factory::custom

(

)

Contains constraints and transformations for custom functions.

Definition at line 92 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

                            : Custom\Group
    {
        $this->language->loadLanguageModule('validation');
        return new Custom\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

dateTime()

ILIAS\Refinery\Factory::dateTime

(

)

Contains transformations for DateTime.

Definition at line 146 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group.

                              : DateTime\Group
    {
        return new DateTime\Group();
    }

encode()

ILIAS\Refinery\Factory::encode

(

)

Definition at line 159 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group.

                            : Encode\Group
    {
        return new Encode\Group();
    }

executable()

ILIAS\Refinery\Factory::executable

(

)

Definition at line 189 of file Factory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                                : Transformation
    {
        $this->loadLanguageModules();
        return new IsExecutableTransformation($this->language);
    }

Here is the call graph for this function:

identity()

ILIAS\Refinery\Factory::identity

(

)

Definition at line 179 of file Factory.php.

                              : Transformation
    {
        return new IdentityTransformation();
    }

in()

ILIAS\Refinery\Factory::in

(

)

Creates a factory object to create a transformation object, that can be used to execute other transformation objects in a desired order.

Definition at line 65 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group.

Referenced by ILIAS\Refinery\Factory\int().

                        : In\Group
    {
        return new In\Group();
    }

Here is the caller graph for this function:

int()

ILIAS\Refinery\Factory::int

(

)

Contains constraints and transformations on numbers.

Each constraint on an int will attempt to transform to int as well.

Definition at line 74 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\Refinery\Factory\in(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                         : Integer\Group
    {
        $this->loadLanguageModules();
        return new Integer\Group($this->dataFactory, $this->language, $this->in());
    }

Here is the call graph for this function:

kindlyTo()

ILIAS\Refinery\Factory::kindlyTo

(

)

Combined validations and transformations for primitive data types that establish a baseline for further constraints and more complex transformations.

Other then the to-group, the kindlyTo transformation attempts to implement Postels Law by being reasonably liberal when interpreting data. Look into the various transformations in the group for detailed information what works exactly.

Definition at line 55 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group.

Referenced by ilObjGroupGUI\_goto(), and ilObjCourseGUI\_goto().

                              : KindlyTo\Group
    {
        return new KindlyTo\Group($this->dataFactory);
    }

Here is the caller graph for this function:

loadLanguageModules()

ILIAS\Refinery\Factory::loadLanguageModules ( )

protected

Definition at line 195 of file Factory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by ILIAS\Refinery\Factory\byTrying(), ILIAS\Refinery\Factory\container(), ILIAS\Refinery\Factory\executable(), ILIAS\Refinery\Factory\int(), ILIAS\Refinery\Factory\logical(), ILIAS\Refinery\Factory\null(), ILIAS\Refinery\Factory\numeric(), ILIAS\Refinery\Factory\password(), ILIAS\Refinery\Factory\string(), and ILIAS\Refinery\Factory\to().

                                            : void
    {
        $this->language->loadLanguageModule('validation');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logical()

ILIAS\Refinery\Factory::logical

(

)

Contains constraints for logical compositions with other constraints.

Definition at line 119 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                             : Logical\Group
    {
        $this->loadLanguageModules();
        return new Logical\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

null()

ILIAS\Refinery\Factory::null

(

)

Contains constraints for null types.

Definition at line 128 of file Factory.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                          : Constraint
    {
        $this->loadLanguageModules();
        return new IsNull($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

numeric()

ILIAS\Refinery\Factory::numeric

(

)

Contains constraints for numeric data types.

Definition at line 137 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                             : Numeric\Group
    {
        $this->loadLanguageModules();
        return new Numeric\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

password()

ILIAS\Refinery\Factory::password

(

)

Contains constraints for password strings.

Definition at line 110 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                              : Password\Group
    {
        $this->loadLanguageModules();
        return new Password\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

random()

ILIAS\Refinery\Factory::random

(

)

Definition at line 174 of file Factory.php.

                            : RandomGroup
    {
        return new RandomGroup();
    }

string()

ILIAS\Refinery\Factory::string

(

)

Contains constraints for string.

Definition at line 83 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

                            : String\Group
    {
        $this->loadLanguageModules();
        return new String\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

to()

ILIAS\Refinery\Factory::to

(

)

Combined validations and transformations for primitive data types that establish a baseline for further constraints and more complex transformations.

Definition at line 40 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Refinery\Factory\loadLanguageModules().

Referenced by ILIAS\StaticURL\Request\StaticURLRequestBuilder\buildRequest(), and ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest().

                        : To\Group
    {
        $this->loadLanguageModules();
        return new To\Group($this->dataFactory, $this->language);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uri()

ILIAS\Refinery\Factory::uri

(

)

Contains transformations for Data.

Definition at line 154 of file Factory.php.

References ILIAS\ILIASObject\Creation\Group.

                         : URI\Group
    {
        return new URI\Group();
    }

Field Documentation

$dataFactory

ILIAS Data Factory ILIAS\Refinery\Factory::$dataFactory

private

Definition at line 27 of file Factory.php.

$language

ILIAS Language Language ILIAS\Refinery\Factory::$language

private

Definition at line 28 of file Factory.php.

---

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

• components/ILIAS/Refinery/src/Factory.php