class YamlFormDocumentFile in YAML Form 8
Same name in this branch
- 8 src/Element/YamlFormDocumentFile.php \Drupal\yamlform\Element\YamlFormDocumentFile
- 8 src/Plugin/YamlFormElement/YamlFormDocumentFile.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormDocumentFile
Provides a 'yamlform_document_file' element.
Plugin annotation
@YamlFormElement(
id = "yamlform_document_file",
label = @Translation("Document file"),
category = @Translation("File upload elements"),
states_wrapper = TRUE,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\yamlform\YamlFormElementBase implements YamlFormElementInterface uses StringTranslationTrait
- class \Drupal\yamlform\Plugin\YamlFormElement\YamlFormManagedFileBase
- class \Drupal\yamlform\Plugin\YamlFormElement\YamlFormDocumentFile
- class \Drupal\yamlform\Plugin\YamlFormElement\YamlFormManagedFileBase
- class \Drupal\yamlform\YamlFormElementBase implements YamlFormElementInterface uses StringTranslationTrait
Expanded class hierarchy of YamlFormDocumentFile
File
- src/
Plugin/ YamlFormElement/ YamlFormDocumentFile.php, line 15
Namespace
Drupal\yamlform\Plugin\YamlFormElementView source
class YamlFormDocumentFile extends YamlFormManagedFileBase {
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
YamlFormElementBase:: |
protected | property | The configuration factory. | |
YamlFormElementBase:: |
protected | property | The current user. | |
YamlFormElementBase:: |
protected | property | A element info manager. | |
YamlFormElementBase:: |
protected | property | The form element manager. | |
YamlFormElementBase:: |
protected | property | The entity type manager. | |
YamlFormElementBase:: |
protected | property | A logger instance. | |
YamlFormElementBase:: |
protected | property | The token manager. | |
YamlFormElementBase:: |
protected | function | Build an element as text or HTML. | 2 |
YamlFormElementBase:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Build an element's export header. Overrides YamlFormElementInterface:: |
3 |
YamlFormElementBase:: |
public | function |
Get an element's export options form. Overrides YamlFormElementInterface:: |
4 |
YamlFormElementBase:: |
public | function |
Build an element's export row. Overrides YamlFormElementInterface:: |
5 |
YamlFormElementBase:: |
public | function |
Build an element as HTML element. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Build an element as text element. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Check element access (rules). Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
YamlFormElementBase:: |
public | function |
Format an element's table column value. Overrides YamlFormElementInterface:: |
2 |
YamlFormElementBase:: |
public | function |
Get an element's admin label (#admin_title, #title or #yamlform_key). Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get an associative array of element properties from configuration form. Overrides YamlFormElementInterface:: |
2 |
YamlFormElementBase:: |
protected | function | Get configuration property value. | 1 |
YamlFormElementBase:: |
protected | function | Get default base properties used by all elements. | |
YamlFormElementBase:: |
protected | function | Get an element's (sub)inputs selectors as options. | 7 |
YamlFormElementBase:: |
public | function |
Get an element's supported states as options. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get an element's default export options. Overrides YamlFormElementInterface:: |
4 |
YamlFormElementBase:: |
public | function |
Get element's format name by looking for '#format' property, global settings, and finally default settings. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Retrieves the default properties for the defined element type. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get an element's key/name. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get an element's label (#title or #yamlform_key). Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get link to element's API documentation. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get the URL for the element's API documentation. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Gets the label of the plugin instance. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Get related element types. Overrides YamlFormElementInterface:: |
3 |
YamlFormElementBase:: |
public | function |
Get element's table column(s) settings. Overrides YamlFormElementInterface:: |
3 |
YamlFormElementBase:: |
public | function |
Get translatable properties. Overrides YamlFormElementInterface:: |
7 |
YamlFormElementBase:: |
public | function |
Gets the type name (aka id) of the plugin instance with the 'yamlform_' prefix. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Determine if an element supports a specified property. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Checks if the element has a wrapper. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Initialize an element to be displayed, rendered, or exported. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Checks if element is a composite element. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Checks if element is a container that can contain elements. Overrides YamlFormElementInterface:: |
3 |
YamlFormElementBase:: |
public | function |
Checks if element is disabled. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Checks if element is hidden. Overrides YamlFormElementInterface:: |
|
YamlFormElementBase:: |
public | function |
Checks if the element carries a value. Overrides YamlFormElementInterface:: |
5 |
YamlFormElementBase:: |
public | function |
Checks if element is a root element. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Acts on a form submission element after it is created. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Acts on loaded form submission. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function |
Changes the values of an entity before it is created. Overrides YamlFormElementInterface:: |
1 |
YamlFormElementBase:: |
public | function | 1 | |
YamlFormElementBase:: |
protected | function | Prefix an element's export header. | |
YamlFormElementBase:: |
public | function |
Acts on a form submission element before the presave hook is invoked. Overrides YamlFormElementInterface:: |
2 |
YamlFormElementBase:: |
protected | function | Set an element's configuration form element default value. | 2 |
YamlFormElementBase:: |
protected | function | Set configuration form default values recursively. | |
YamlFormElementBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
YamlFormElementBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
3 |
YamlFormElementBase:: |
public static | function | Form API callback. Validate #unique value. | |
YamlFormElementBase:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
YamlFormManagedFileBase:: |
public static | function | Control access to form submission private file downloads. | |
YamlFormManagedFileBase:: |
public | function |
Display element disabled warning. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Gets the actual configuration form array to be built. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Format an element's value as HTML. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
protected | function | Format a managed files as array of strings. | |
YamlFormManagedFileBase:: |
public | function |
Format an element's value as plain text. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Get an element's default format name. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Only a few elements don't inherit these default properties. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Get an element's selectors as options. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
protected | function | Get allowed file extensions for an element. | |
YamlFormManagedFileBase:: |
public | function |
Get an element's available formats. Overrides YamlFormElementBase:: |
3 |
YamlFormManagedFileBase:: |
protected | function | Get max file size for an element. | |
YamlFormManagedFileBase:: |
public | function |
Get test value for an element. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
protected | function | Get file upload location. | |
YamlFormManagedFileBase:: |
protected | function | Get file upload URI scheme. | |
YamlFormManagedFileBase:: |
public static | function | Get visible stream wrappers. | |
YamlFormManagedFileBase:: |
public | function |
Checks if element value has multiple values. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Checks if element is enabled. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Checks if element value could contain multiple lines. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Delete any additional value associated with an element. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Acts on a saved form submission element before the insert or update hook is invoked. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Prepare an element to be rendered within a form. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
protected | function |
Set an elements Flexbox and #states wrapper. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public | function |
Set an element's default value using saved data. Overrides YamlFormElementBase:: |
|
YamlFormManagedFileBase:: |
public static | function | Form API callback. Consolidate the array of fids for this field into a single fids. |