You are here

Home » API reference » DataTables 8 » DataTables.php

class DataTables in DataTables 8

Same name and namespace in other branches
  1. 2.x src/Plugin/views/style/DataTables.php \Drupal\datatables\Plugin\views\style\DataTables
  2. 1.x src/Plugin/views/style/DataTables.php \Drupal\datatables\Plugin\views\style\DataTables

Style plugin to render a table as a FooTable.

Plugin annotation


@ViewsStyle(
  id = "datatables",
  title = @Translation("DataTables"),
  help = @Translation("Render a table as a DataTable."),
  theme = "views_view_datatables",
  display_types = { "normal" }
)

Hierarchy

Expanded class hierarchy of DataTables

1 string reference to 'DataTables'
datatables.info.yml in ./datatables.info.yml
datatables.info.yml

File

src/Plugin/views/style/DataTables.php, line 22

Namespace

Drupal\datatables\Plugin\views\style
View source 
class DataTables extends Table {

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesRowClass = TRUE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    unset($options['sticky']);
    unset($options['override']);
    $options['elements'] = [
      'default' => [
        'search_box' => TRUE,
        'table_info' => TRUE,
        'save_state' => FALSE,
      ],
    ];
    $options['layout'] = [
      'default' => [
        'autowidth' => FALSE,
        'themeroller' => FALSE,
        'sdom' => '',
      ],
    ];
    $options['pages'] = [
      'default' => [
        'pagination_style' => 0,
        'length_change' => 0,
        'display_length' => 10,
      ],
    ];
    $options['hidden_columns'] = [
      'default' => [],
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    unset($form['sticky']);
    unset($form['override']);
    $form['description_markup']['#markup'] = '<div class="description form-item">' . $this
      ->t('DataTables works best if you set the pager to display all items, since DataTabels contains its own pager implementation.<br/><br/>Place fields into columns; you may combine multiple fields into the same column. If you do, the separator in the column specified will be used to separate the fields. Check the sortable box to make that column click sortable, and check the default sort radio to determine which column will be sorted by default, if any. You may control column order and field labels in the fields section.') . '</div>';
    $form['elements'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Widgets & Elements'),
      '#open' => FALSE,
    ];
    $form['elements']['search_box'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable the search filter box.'),
      '#description' => $this
        ->t('The search filter box allows users to dynamically filter the results in the table.  Disabling this option will hide the search filter box from users.'),
      '#default_value' => $this->options['elements']['search_box'],
    ];
    $form['elements']['table_info'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable the table information display.'),
      '#description' => $this
        ->t('This shows information about the data that is currently visible on the page, including information about filtered data if that action is being performed.'),
      '#default_value' => $this->options['elements']['table_info'],
    ];
    $form['elements']['save_state'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Save State'),
      '#description' => $this
        ->t("DataTables can use cookies in the end user's web-browser in order to store it's state after each change in drawing. What this means is that if the user were to reload the page, the table should remain exactly as it was (length, filtering, pagination and sorting)"),
      '#default_value' => $this->options['elements']['save_state'],
    ];
    $form['elements']['table_tools'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Table Tools'),
      '#description' => $this
        ->t('Table Tools is a plugin that adds a powerful button toolbar with copy, save, and print capabilities. See <a href="http://datatables.net/extras/tabletools/">TableTools Help</a> for more information.  Note that if you have custom sDom settings, TableTools can be included by inserting the "T" character.'),
      '#default_value' => $this->options['elements']['table_tools'],
    ];
    $form['layout'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Layout and Display'),
      '#open' => FALSE,
    ];
    $form['layout']['autowidth'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable auto-width calculation.'),
      '#description' => $this
        ->t('Enable or disable automatic column width calculation. This can be disabled as an optimisation (it takes some time to calculate the widths).'),
      '#default_value' => $this->options['layout']['autowidth'],
    ];
    $form['layout']['themeroller'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable jQuery UI ThemeRoller Support'),
      '#description' => $this
        ->t("Create markup and classes to support jQuery UI's ThemeRoller"),
      '#default_value' => $this->options['layout']['themeroller'],
    ];
    $form['layout']['sdom'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Set sDOM Initialization Parameter'),
      '#description' => $this
        ->t("Use the sDOM parameter to rearrange the interface elements. See the <a href='@sdom_documentation_url'>Datatables sDOM documentation</a> for details on how to use this feature", [
        '@sdom_documentation_url' => 'http://www.datatables.net/examples/basic_init/dom.html',
      ]),
      '#default_value' => $this->options['layout']['sdom'],
    ];
    $form['pages'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Pagination and Page Length'),
      '#open' => FALSE,
    ];
    $form['pages']['pagination_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Pagination Style'),
      '#description' => $this
        ->t('Selects which pagination style should be used.'),
      '#options' => [
        0 => $this
          ->t('Two-Button (Default)'),
        'full_numbers' => $this
          ->t('Full Numbers'),
        'no_pagination' => $this
          ->t('No Pagination'),
      ],
      '#default_value' => $this->options['pages']['pagination_style'],
    ];
    $form['pages']['length_change'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable Length Change Selection Box'),
      '#description' => $this
        ->t('Enable or page length selection menu'),
      '#default_value' => $this->options['pages']['length_change'],
    ];
    $form['pages']['display_length'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default Page Length'),
      '#description' => $this
        ->t('Default number of records to show per page. May be adjusted by users if Length Selection is enabled'),
      '#min' => 1,
      '#default_value' => $this->options['pages']['display_length'],
    ];
    $form['hidden_columns'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Hidden and Expandable Columns'),
      '#open' => FALSE,
    ];
    foreach ($this->displayHandler
      ->getFieldLabels() as $name => $label) {
      $form['hidden_columns'][$name] = [
        '#type' => 'select',
        '#title' => Html::escape($label),
        '#options' => [
          0 => $this
            ->t('Visible'),
          'hidden' => $this
            ->t('Hidden'),
          'expandable' => $this
            ->t('Hidden and Expandable'),
        ],
        '#default_value' => isset($this->options['hidden_columns'][$name]) ? $this->options['hidden_columns'][$name] : 0,
      ];
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DataTables::$usesFields protected property Does the style plugin for itself support to add fields to its output. Overrides Table::$usesFields
DataTables::$usesRowClass protected property Does the style plugin support custom css class for the rows. Overrides Table::$usesRowClass
DataTables::$usesRowPlugin protected property Whether or not this style uses a row plugin. Overrides Table::$usesRowPlugin
DataTables::buildOptionsForm public function Render the given style. Overrides Table::buildOptionsForm
DataTables::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides Table::defineOptions
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's 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::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. 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::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. 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 Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm 16
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StylePluginBase::$groupingTheme protected property The theme function used to render the grouping set.
StylePluginBase::$rendered_fields protected property Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens protected property Store all available tokens row rows.
StylePluginBase::$usesGrouping protected property Does the style plugin support grouping of rows. 3
StylePluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::defaultFieldLabels public function Return TRUE if this style enables field labels by default. 1
StylePluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow public function #pre_render callback for view row field rendering.
StylePluginBase::getField public function Gets a rendered field.
StylePluginBase::getFieldValue public function Get the raw field value.
StylePluginBase::getRowClass public function Return the token replaced row class for the specified row.
StylePluginBase::init public function Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender public function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
StylePluginBase::render public function Render the display in this style. 7
StylePluginBase::renderFields protected function Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping public function Group records as needed for rendering.
StylePluginBase::renderGroupingSets public function Render the grouping sets.
StylePluginBase::renderRowGroup protected function Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue public function Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields public function Return TRUE if this style also uses fields. 3
StylePluginBase::usesGrouping public function Returns the usesGrouping property. 3
StylePluginBase::usesRowClass public function Returns the usesRowClass property. 3
StylePluginBase::usesRowPlugin public function Returns the usesRowPlugin property. 10
StylePluginBase::usesTokens public function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm public function Provide a form in the views wizard if this style is selected.
Table::$active public property Contains the current active sort column.
Table::$defaultFieldLabels protected property Should field labels be enabled by default. Overrides StylePluginBase::$defaultFieldLabels
Table::$order public property Contains the current active sort order, either desc or asc.
Table::buildSort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. Overrides StylePluginBase::buildSort
Table::buildSortPost public function Add our actual sort criteria Overrides StylePluginBase::buildSortPost
Table::evenEmpty public function Should the output of the style plugin be rendered even if it's a empty view. Overrides StylePluginBase::evenEmpty
Table::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
Table::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
Table::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
Table::sanitizeColumns public function Normalize a list of columns based upon the fields that are available. This compares the fields stored in the style handler to the list of fields actually in the view, removing fields that have been removed and adding new fields in their own column.
Table::wizardSubmit public function Alter the options of a display before they are added to the view. Overrides StylePluginBase::wizardSubmit
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.