class Text
Same name in other branches
- 9 core/modules/views/src/Plugin/views/area/Text.php \Drupal\views\Plugin\views\area\Text
- 8.9.x core/modules/views/src/Plugin/views/area/Text.php \Drupal\views\Plugin\views\area\Text
- 11.x core/modules/views/src/Plugin/views/area/Text.php \Drupal\views\Plugin\views\area\Text
Views area text handler.
Hierarchy
- class \Drupal\views\Plugin\views\area\Text extends \Drupal\views\Plugin\views\area\TokenizeAreaPluginBase
Expanded class hierarchy of Text
Related topics
360 string references to 'Text'
- AccessTest::testFileAccess in core/
modules/ file/ tests/ src/ Kernel/ AccessTest.php - Tests 'update' and 'delete' access to file entities.
- action.schema.yml in core/
modules/ action/ config/ schema/ action.schema.yml - core/modules/action/config/schema/action.schema.yml
- badge.component.yml in core/
profiles/ demo_umami/ themes/ umami/ components/ badge/ badge.component.yml - core/profiles/demo_umami/themes/umami/components/badge/badge.component.yml
- block_content.schema.yml in core/
modules/ block_content/ config/ schema/ block_content.schema.yml - core/modules/block_content/config/schema/block_content.schema.yml
- claro_preprocess_input in core/
themes/ claro/ claro.theme - Implements template_preprocess_HOOK() for input.
File
-
core/
modules/ views/ src/ Plugin/ views/ area/ Text.php, line 13
Namespace
Drupal\views\Plugin\views\areaView source
class Text extends TokenizeAreaPluginBase {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['content'] = [
'contains' => [
'value' => [
'default' => '',
],
'format' => [
'default' => NULL,
],
],
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['content'] = [
'#title' => $this->t('Content'),
'#type' => 'text_format',
'#default_value' => $this->options['content']['value'],
'#rows' => 6,
'#format' => $this->options['content']['format'] ?? filter_default_format(),
'#editor' => FALSE,
];
}
/**
* {@inheritdoc}
*/
public function preQuery() {
$content = $this->options['content']['value'];
// Check for tokens that require a total row count.
if (str_contains($content, '[view:page-count]') || str_contains($content, '[view:total-rows]')) {
$this->view->get_total_rows = TRUE;
}
}
/**
* {@inheritdoc}
*/
public function render($empty = FALSE) {
$format = $this->options['content']['format'] ?? filter_default_format();
if (!$empty || !empty($this->options['empty'])) {
return [
'#type' => 'processed_text',
'#text' => $this->tokenizeValue($this->options['content']['value']),
'#format' => $format,
];
}
return [];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AreaPluginBase::$areaType | public | property | The type of this area handler, i.e. 'header', 'footer', or 'empty'. | |||
AreaPluginBase::adminSummary | public | function | Overrides HandlerBase::adminSummary | |||
AreaPluginBase::init | public | function | Overrides Drupal\views\Plugin\views\HandlerBase::init(). | Overrides HandlerBase::init | 1 | |
AreaPluginBase::isEmpty | public | function | Does that area have nothing to show. | 1 | ||
AreaPluginBase::preRender | public | function | Performs any operations needed before full rendering. | 1 | ||
AreaPluginBase::usesGroupBy | public | function | Overrides HandlerBase::usesGroupBy | |||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | |||
HandlerBase::$is_handler | public | property | ||||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | ||
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | ||
HandlerBase::$realField | public | property | The real field. | |||
HandlerBase::$relationship | public | property | The relationship used for this field. | |||
HandlerBase::$table | public | property | The table this handler is attached to. | |||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | |||
HandlerBase::$viewsData | protected | property | The views data service. | |||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | ||
HandlerBase::access | public | function | Overrides ViewsHandlerInterface::access | 5 | ||
HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | ||
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | |||
HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | |||
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | ||
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | ||
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | ||
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | ||
HandlerBase::calculateDependencies | public | function | Overrides PluginBase::calculateDependencies | 10 | ||
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | ||
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | |||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | ||
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | |||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | |||
HandlerBase::ensureMyTable | public | function | Overrides ViewsHandlerInterface::ensureMyTable | 2 | ||
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | ||
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | ||
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | ||
HandlerBase::getEntityType | public | function | Overrides ViewsHandlerInterface::getEntityType | |||
HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | |||
HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | |||
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | |||
HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | |||
HandlerBase::getViewsData | protected | function | Gets views data service. | |||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 1 | ||
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | ||
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | |||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | ||
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | |||
HandlerBase::postExecute | public | function | Overrides ViewsHandlerInterface::postExecute | |||
HandlerBase::query | public | function | Overrides PluginBase::query | 7 | ||
HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | |||
HandlerBase::setModuleHandler | public | function | Sets the module handler. | |||
HandlerBase::setRelationship | public | function | Overrides ViewsHandlerInterface::setRelationship | |||
HandlerBase::setViewsData | public | function | ||||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | ||
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | ||
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | ||
HandlerBase::submitExposed | public | function | Submit the exposed handler form. | |||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. | |||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | |||
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | ||
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | ||
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | |||
HandlerBase::validate | public | function | Overrides PluginBase::validate | 2 | ||
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 4 | ||
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | ||
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | |||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 42 | |
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | ||
PluginBase::$view | public | property | The top object of a view. | 1 | ||
PluginBase::create | public static | function | Overrides ContainerFactoryPluginInterface::create | 60 | ||
PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | ||
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | |||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | |||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | |||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::submitOptionsForm | public | function | Overrides ViewsPluginInterface::submitOptionsForm | 16 | ||
PluginBase::summaryTitle | public | function | Overrides ViewsPluginInterface::summaryTitle | 6 | ||
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | ||
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | ||
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | ||
PluginBase::validateOptionsForm | public | function | Overrides ViewsPluginInterface::validateOptionsForm | 15 | ||
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | ||
Text::buildOptionsForm | public | function | Overrides TokenizeAreaPluginBase::buildOptionsForm | |||
Text::defineOptions | protected | function | Overrides TokenizeAreaPluginBase::defineOptions | |||
Text::preQuery | public | function | Overrides HandlerBase::preQuery | |||
Text::render | public | function | Overrides AreaPluginBase::render | |||
TokenizeAreaPluginBase::tokenForm | public | function | Adds tokenization form elements. | |||
TokenizeAreaPluginBase::tokenizeValue | public | function | Replaces value with special views tokens and global tokens. | |||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.