ilObjectPropertyIsOnline Class Reference

Inheritance diagram for ilObjectPropertyIsOnline:

Collaboration diagram for ilObjectPropertyIsOnline:

Public Member Functions
	__construct (private bool $is_online=self::DEFAULT_IS_ONLINE)
	getIsOnline ()
	withOnline ()
	withOffline ()
	toForm (\ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)
Public Member Functions inherited from ilObjectProperty
	toForm (ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)

Private Attributes
const	DEFAULT_IS_ONLINE = false
const	INPUT_LABEL = 'online'
const	INPUT_BYLINE = 'online_input_byline'

Detailed Description

Author

Stephan Kergomard

Definition at line 28 of file ilObjectPropertyIsOnline.php.

Constructor & Destructor Documentation

__construct()

ilObjectPropertyIsOnline::__construct

(

private bool

$is_online = self::DEFAULT_IS_ONLINE

)

Definition at line 34 of file ilObjectPropertyIsOnline.php.

      {
    }

Member Function Documentation

getIsOnline()

ilObjectPropertyIsOnline::getIsOnline

(

)

Definition at line 39 of file ilObjectPropertyIsOnline.php.

Referenced by toForm().

                                 : bool
    {
        return $this->is_online;
    }

Here is the caller graph for this function:

toForm()

ilObjectPropertyIsOnline::toForm	(	\ilLanguage	$language,
		FieldFactory	$field_factory,
		Refinery	$refinery
	)

Definition at line 58 of file ilObjectPropertyIsOnline.php.

References getIsOnline(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

     : Checkbox {
        $trafo = $refinery->custom()->transformation(
            function ($v): ilObjectProperty {
                return new ilObjectPropertyIsOnline($v);
            }
        );
        return $field_factory->checkbox($language->txt(self::INPUT_LABEL))
            ->withByline($language->txt(self::INPUT_BYLINE))
            ->withAdditionalTransformation($trafo)
            ->withValue($this->getIsOnline());
    }

Here is the call graph for this function:

withOffline()

ilObjectPropertyIsOnline::withOffline

(

)

Definition at line 51 of file ilObjectPropertyIsOnline.php.

                                 : self
    {
        $clone = clone $this;
        $clone->is_online = false;
        return $clone;
    }

withOnline()

ilObjectPropertyIsOnline::withOnline

(

)

Definition at line 44 of file ilObjectPropertyIsOnline.php.

                                : self
    {
        $clone = clone $this;
        $clone->is_online = true;
        return $clone;
    }

Field Documentation

DEFAULT_IS_ONLINE

const ilObjectPropertyIsOnline::DEFAULT_IS_ONLINE = false

private

Definition at line 30 of file ilObjectPropertyIsOnline.php.

INPUT_BYLINE

const ilObjectPropertyIsOnline::INPUT_BYLINE = 'online_input_byline'

private

Definition at line 32 of file ilObjectPropertyIsOnline.php.

INPUT_LABEL

const ilObjectPropertyIsOnline::INPUT_LABEL = 'online'

private

Definition at line 31 of file ilObjectPropertyIsOnline.php.

---

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

• components/ILIAS/ILIASObject/classes/Properties/CoreProperties/ilObjectPropertyIsOnline.php