interface RulesDataInputOptionsListInterface

Interface for data UI classes providing an options list.

Hierarchy

Expanded class hierarchy of RulesDataInputOptionsListInterface

All classes that implement RulesDataInputOptionsListInterface

1 string reference to 'RulesDataInputOptionsListInterface'
RulesPluginUI::getDataTypeClass in ui/ui.core.inc
Returns the name of class for the given data type.

File

ui/ui.data.inc, line 34

View source 
interface RulesDataInputOptionsListInterface extends RulesDataDirectInputFormInterface {
    
    /**
     * Returns the options list for the data type.
     *
     * For retrieving information about the used data type and parameter, the
     * helper RulesDataUI::getTypeInfo() may be used as following:
     * @code
     *   list($type, $parameter_info) = RulesDataUI::getTypeInfo($element, $name);
     * @endcode
     *
     * @param RulesPlugin $element
     *   The rules element to get the options for.
     * @param string $name
     *   The name of the parameter for which to get options.
     *
     * @return array
     *   An array of options as used by hook_options_list().
     */
    public static function optionsList(RulesPlugin $element, $name);

}

Members

Title Modifiers Object type Summary Overrides
RulesDataDirectInputFormInterface::inputForm public static function Constructs the direct input form. 2
RulesDataDirectInputFormInterface::render public static function Render the configured value. 2
RulesDataInputOptionsListInterface::optionsList public static function Returns the options list for the data type. 2