Class ilMMAbstractBaseTypeHandlerAction. More...

Inheritance diagram for ilMMAbstractBaseTypeHandlerAction:

Collaboration diagram for ilMMAbstractBaseTypeHandlerAction:

Public Member Functions

__construct ()

matchesForType ()

enrichItem (isItem $item)

Parameters

isItem $item

Returns: isItem

More...

saveFormFields (\ILIAS\GlobalScreen\Identification\IdentificationInterface $identification, array $data)

getAdditionalFieldsForSubForm (\ILIAS\GlobalScreen\Identification\IdentificationInterface $identification)

Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Collector\Handler\TypeHandler

matchesForType ()

enrichItem (isItem $item)

getAdditionalFieldsForSubForm (IdentificationInterface $identification)

saveFormFields (IdentificationInterface $identification, array $data)

Data Fields
const	F_ACTION = 'action'
	@inheritDoc More...

const	F_EXTERNAL = 'external'
	ilMMAbstractBaseTypeHandlerAction constructor. More...

Protected Member Functions
	getFieldTranslation ()

	getFieldInfoTranslation ()

Protected Attributes
	$links = []

Detailed Description

Class ilMMAbstractBaseTypeHandlerAction.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 11 of file class.ilMMAbstractBaseTypeHandlerAction.php.

Constructor & Destructor Documentation

◆ __construct()

ilMMAbstractBaseTypeHandlerAction::__construct ( )

Definition at line 28 of file class.ilMMAbstractBaseTypeHandlerAction.php.

    {
        $this->links = ilMMTypeActionStorage::getArray('identification', [self::F_ACTION, self::F_EXTERNAL]);
    }

References ActiveRecord\getArray().

Here is the call graph for this function:

Member Function Documentation

◆ enrichItem()

ilMMAbstractBaseTypeHandlerAction::enrichItem ( isItem $item )

abstract

Parameters

isItem $item

Returns: isItem

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Handler\TypeHandler.

Reimplemented in ilMMTypeHandlerLink, ilMMTypeHandlerRepositoryLink, and ilMMTypeHandlerTopLink.

◆ getAdditionalFieldsForSubForm()

ilMMAbstractBaseTypeHandlerAction::getAdditionalFieldsForSubForm ( \ILIAS\GlobalScreen\Identification\IdentificationInterface $identification )

Definition at line 57 of file class.ilMMAbstractBaseTypeHandlerAction.php.

                                                                                                                              : array
    {
        global $DIC;
        $url = $DIC->ui()->factory()->input()->field()->text($this->getFieldTranslation())->withRequired(true)->withByline($this->getFieldInfoTranslation());
        if (isset($this->links[$identification->serialize()][self::F_ACTION])) {
            $url = $url->withValue($this->links[$identification->serialize()][self::F_ACTION]);
        }
        $external = $DIC->ui()->factory()->input()->field()->checkbox($DIC->language()->txt('field_external'), $DIC->language()->txt('field_external_info'));
        if (isset($this->links[$identification->serialize()][self::F_EXTERNAL])) {
            $external = $external->withValue((bool) $this->links[$identification->serialize()][self::F_EXTERNAL]);
        }
 
        return [self::F_ACTION => $url, self::F_EXTERNAL => $external];
    }

References $DIC, $url, getFieldInfoTranslation(), and getFieldTranslation().

Here is the call graph for this function:

◆ getFieldInfoTranslation()

ilMMAbstractBaseTypeHandlerAction::getFieldInfoTranslation ( )

abstractprotected

Reimplemented in ilMMTypeHandlerLink, ilMMTypeHandlerRepositoryLink, and ilMMTypeHandlerTopLink.

Referenced by getAdditionalFieldsForSubForm().

Here is the caller graph for this function:

◆ getFieldTranslation()

ilMMAbstractBaseTypeHandlerAction::getFieldTranslation ( )

abstractprotected

Returns: string

Reimplemented in ilMMTypeHandlerLink, ilMMTypeHandlerRepositoryLink, and ilMMTypeHandlerTopLink.

Referenced by getAdditionalFieldsForSubForm().

Here is the caller graph for this function:

◆ matchesForType()

ilMMAbstractBaseTypeHandlerAction::matchesForType ( )

abstract

Returns: string Classname of matching Type this TypeHandler can handle

Implements ILIAS\GlobalScreen\Scope\MainMenu\Collector\Handler\TypeHandler.

Reimplemented in ilMMTypeHandlerLink, ilMMTypeHandlerRepositoryLink, and ilMMTypeHandlerTopLink.

◆ saveFormFields()

ilMMAbstractBaseTypeHandlerAction::saveFormFields	(	\ILIAS\GlobalScreen\Identification\IdentificationInterface	$identification,
		array	$data
	)

Definition at line 46 of file class.ilMMAbstractBaseTypeHandlerAction.php.

                                                                                                                            : bool
    {
        ilMMTypeActionStorage::find($identification->serialize())->setAction((string) $data[self::F_ACTION])->setExternal((bool) $data[self::F_EXTERNAL])->update();
 
        return true;
    }