class Title

Views area title override handler.

Plugin annotation


@Plugin(
  id = "title"
)

Hierarchy

Expanded class hierarchy of Title

Related topics

Views area handlers
Handlers to tell Views what can display in header, footer and empty text in a view.
34 string references to 'Title'
aggregator_form_category in drupal/core/modules/aggregator/aggregator.admin.inc
Form constructor to add/edit/delete aggregator categories.
aggregator_form_feed in drupal/core/modules/aggregator/aggregator.admin.inc
Form constructor for adding and editing feed sources.
aggregator_view in drupal/core/modules/aggregator/aggregator.admin.inc
Displays the aggregator administration page.
comment_token_info in drupal/core/modules/comment/comment.tokens.inc
Implements hook_token_info().
comment_views_data in drupal/core/modules/comment/comment.views.inc
Implements hook_views_data().

... See full list

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/area/Title.php, line 21
Definition of Drupal\views\Plugin\views\area\Title.

Namespace

Drupal\views\Plugin\views\area
View source
class Title extends AreaPluginBase {

  /**
   * Overrides Drupal\views\Plugin\views\AreaPluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['title'] = array(
      'default' => '',
      'translatable' => TRUE,
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\AreaPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['title'] = array(
      '#type' => 'textfield',
      '#title' => t('Overridden title'),
      '#default_value' => $this->options['title'],
      '#description' => t('Override the title of this view when it is empty. The available global tokens below can be used here.'),
    );

    // Don't use the AreaPluginBase tokenForm method, we don't want row tokens.
    $this
      ->globalTokenForm($form, $form_state);
  }

  /**
   * Overrides Drupal\views\Plugin\views\AreaPluginBase::preRender().
   */
  public function preRender(array $results) {
    if (!empty($this->options['title'])) {
      $value = $this
        ->globalTokenReplace($this->options['title']);
      $this->view
        ->setTitle($this
        ->sanitizeValue($value, 'xss_admin'), PASS_THROUGH);
    }
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AreaPluginBase::adminSummary public function Provide extra data to the administration form Overrides HandlerBase::adminSummary
AreaPluginBase::init public function Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase::init
AreaPluginBase::label public function Get this area's label.
AreaPluginBase::query public function Don't run a query Overrides PluginBase::query 1
AreaPluginBase::render function Render the area 6
AreaPluginBase::tokenForm public function Form helper function to add tokenization form elements.
AreaPluginBase::usesGroupBy public function Area handlers shouldn't have groupby. Overrides HandlerBase::usesGroupBy
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
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::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether current user has access to this handler. 6
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
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::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::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called 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', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
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. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 7
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 4
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
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::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
Title::buildOptionsForm public function Overrides Drupal\views\Plugin\views\AreaPluginBase::buildOptionsForm(). Overrides AreaPluginBase::buildOptionsForm
Title::defineOptions protected function Overrides Drupal\views\Plugin\views\AreaPluginBase::defineOptions(). Overrides AreaPluginBase::defineOptions
Title::preRender public function Overrides Drupal\views\Plugin\views\AreaPluginBase::preRender(). Overrides AreaPluginBase::preRender