\Moo_EditableFieldMemberList
Moo_EditableFieldMemberList is an object representing member dropdown field created by CMS admin.
- Author: Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
Synopsis
class Moo_EditableFieldMemberList
extends Moo_EditableField
{
- // members
- private static string $singular_name = 'Member List Field';
- private static string $plural_name = 'Member List Fields';
- protected array $customSettingsFields = ;
- // Inherited members from Moo_EditableField
- protected array $customSettingsFields;
- protected FormField $field;
- // methods
- public array getFieldConfiguration()
- protected void initFormField()
- // Inherited methods from Moo_EditableField
- public array getSettings()
- public void setSettings()
- public void setSetting()
- public string getSetting()
- public string getIcon()
- public string getIconTag()
- public void getCMSFields()
- public void getCMSValidator()
- public string getTitle()
- public string getSettingName()
- public void onBeforeWrite()
- public FormField getFormField()
- protected FormField initFormField()
- public Varchar getErrorMessage()
- public void onBeforeDuplicate()
Hierarchy
Extends
Members
private
- $plural_name
- $singular_name
protected
- $customSettingsFields
—
array
List of allowed custom settings fields. - $customSettingsFields
—
array
List of fields names part of the custom settings. - $field
—
FormField
Instance of FormField.
Methods
protected
public
- getFieldConfiguration() — Get extra configuration fields.
Inherited from Moo_EditableField
protected
- initFormField() — Initiate a form field.
public
- getCMSFields()
- getCMSValidator()
- getErrorMessage() — Return the error message for this field. Either uses the custom one (if provided) or the default SilverStripe message.
- getFormField() — Return a FormField.
- getIcon() — Get the path to the icon for this field type, relative to the site root.
- getIconTag() — Get the icon HTML tag.
- getSetting() — Return just one custom setting or empty string if it does not exist.
- getSettingName() — Generate a name for the Setting field.
- getSettings() — To prevent having tables for each fields minor settings we store it as a serialized array in the database.
- getTitle() — Returns the Title for rendering in the front-end (with XML values escaped).
- onBeforeDuplicate()
- onBeforeWrite() — How to save the data submitted in this field into the database object which this field represents.
- setSetting() — Set a given field setting. Appends the option to the settings or overrides the existing value.
- setSettings() — Set the custom settings for this field as we store the minor details in a serialized array in the database.