UsersFieldType
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UsersFieldType » Craft\BaseElementFieldType » Craft\BaseFieldType » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
- Craft\IComponentType, Craft\IEagerLoadingFieldType, Craft\IFieldType, Craft\IPreviewableFieldType, Craft\ISavableComponentType,
IApplicationComponent - Since
- 1.0
Class UsersFieldType
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $element | Craft\BaseElementModel |
| $model | Craft\BaseModel |
# Protected Properties
# $elementType
Signature
protected string $elementType = 'User'
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| defineContentAttribute() | Returns the field’s content attribute config. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| getEagerLoadingMap() | Returns an array that maps source-to-target element IDs based on this custom field. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getInputHtml() | Returns the field’s input HTML. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getName() | Returns the component’s name. |
| getSearchKeywords() | Returns the search keywords that should be associated with this field. |
| getSettings() | Returns the component’s settings model. |
| getSettingsHtml() | Returns the component’s settings HTML. |
| getStaticHtml() | Returns a static (non-editable) version of the field’s input HTML. |
| getTableAttributeHtml() | |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| isSelectable() | Returns whether this component should be shown when the user is creating a component of this type. |
| modifyElementsQuery() | Modifies an element query. |
| onAfterDelete() | Performs any actions after a field is deleted. |
| onAfterElementSave() | Performs any additional actions after the element has been saved. |
| onAfterSave() | Performs any actions after a field is saved. |
| onBeforeDelete() | Performs any actions before a field is deleted. |
| onBeforeSave() | Performs any actions before a field is saved. |
| prepSettings() | Preps the settings before they’re saved to the database. |
| prepValue() | Prepares the field’s value for use. |
| prepValueFromPost() | Returns the input value as it should be stored in the database. |
| raiseEvent() (opens new window) | Raises an event. |
| setElement() | Sets the element that the field type is associated with. |
| setIsFresh() | Sets whether the field is fresh. |
| setSettings() | Sets the setting values. |
| validate() | Validates the field’s value. |
# Protected Methods
| Method | Description |
|---|---|
| defineSettings() | Defines the settings. |
| getAddButtonLabel() | Returns the label for the "Add" button. |
| getAvailableSources() | Returns the sources that should be available to choose from within the field's settings |
| getContentPostLocation() | Returns the location in POST that this field's content was pulled from. |
| getElementType() | Returns the element type. |
| getInputSelectionCriteria() | Returns any additional criteria parameters limiting which elements the field should be able to select. |
| getInputSources() | Returns an array of the source keys the field should be able to select elements from. |
| getInputTemplateVariables() | Returns an array of variables that should be passed to the input template. |
| getSettingsModel() | Returns the settings model. |
| getSourceOptions() | Normalizes the available sources into select input options. |
| getSupportedViewModes() | Returns the field’s supported view modes. |
| getTargetLocale() | Returns the locale that target elements should have. |
| getTargetLocaleFieldHtml() | Returns the HTML for the Target Locale setting. |
| getViewMode() | Returns the field’s current view mode. |
| getViewModeFieldHtml() | Returns the HTML for the View Mode setting. |
| isFresh() | Returns whether this is the first time the element's content has been edited. |
# getAddButtonLabel()
Returns the label for the "Add" button.
BaseElementFieldType::getAddButtonLabel()
View source (opens new window)
Returns
Signature
protected string getAddButtonLabel ( )