contao-community-alliance/dc-general
Back to top  

Class GetPropertyOptionsEvent.

This event gets emitted when the options for a property shall get retrieved for the edit view.

 Methods

Get the property name to retrieve the options for.

getFieldName() : string
deprecated this method has been renamed to getPropertyName.

Returns

string

Retrieve the options for the property from the event.

getOptions() : array

Returns

array

Get the property name to retrieve the options for.

getPropertyName() : string

Returns

string

Set the property name to retrieve the options for.

setFieldName(string $propertyName) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent
deprecated this method has been renamed to setPropertyName.
fluent This method is part of a fluent interface and will return the same instance

Parameters

$propertyName

string

The name of the property.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent

Set the options for the property in the event.

setOptions(array $options) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array

The options.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent

Set the property name to retrieve the options for.

setPropertyName(string $propertyName) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$propertyName

string

The name of the property.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent

 Properties

 

The options for the properties.

$options : array
 

The name of the property to retrieve the options for.

$propertyName : string

 Constants

 

NAME

NAME