class Result

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/area/Result.php \Drupal\views\Plugin\views\area\Result
  2. 8.9.x core/modules/views/src/Plugin/views/area/Result.php \Drupal\views\Plugin\views\area\Result
  3. 11.x core/modules/views/src/Plugin/views/area/Result.php \Drupal\views\Plugin\views\area\Result

Views area handler to display some configurable result summary.

Hierarchy

Expanded class hierarchy of Result

Related topics

1 file declares its use of Result
ResultTest.php in core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php
9 string references to 'Result'
ContentEntityBaseUnitTest::providerGet in core/tests/Drupal/Tests/Core/Entity/ContentEntityBaseUnitTest.php
Data provider for testGet().
MessagesTest::setUp in core/modules/views/tests/src/Unit/Plugin/area/MessagesTest.php
ResultTest::setUp in core/modules/views/tests/src/Unit/Plugin/area/ResultTest.php
views.area.schema.yml in core/modules/views/config/schema/views.area.schema.yml
core/modules/views/config/schema/views.area.schema.yml
views.view.test_area_result.yml in core/modules/views/tests/modules/views_test_config/test_views/views.view.test_area_result.yml
core/modules/views/tests/modules/views_test_config/test_views/views.view.test_area_result.yml

... See full list

File

core/modules/views/src/Plugin/views/area/Result.php, line 15

Namespace

Drupal\views\Plugin\views\area
View source
class Result extends AreaPluginBase {
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['content'] = [
            'default' => $this->t('Displaying @start - @end of @total'),
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        $item_list = [
            '#theme' => 'item_list',
            '#items' => [
                '@start -- the initial record number in the set',
                '@end -- the last record number in the set',
                '@total -- the total records in the set',
                '@label -- the human-readable name of the view',
                '@per_page -- the number of items per page',
                '@current_page -- the current page number',
                '@current_record_count -- the current page record count',
                '@page_count -- the total page count',
            ],
        ];
        $list = \Drupal::service('renderer')->render($item_list);
        $form['content'] = [
            '#title' => $this->t('Display'),
            '#type' => 'textarea',
            '#rows' => 3,
            '#default_value' => $this->options['content'],
            '#description' => $this->t('You may use HTML code in this field. The following tokens are supported:') . $list,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        if (str_contains($this->options['content'], '@total')) {
            $this->view->get_total_rows = TRUE;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($empty = FALSE) {
        // Must have options and does not work on summaries.
        if (!isset($this->options['content']) || $this->view->style_plugin instanceof DefaultSummary) {
            return [];
        }
        $output = '';
        $format = $this->options['content'];
        // Calculate the page totals.
        $current_page = (int) $this->view
            ->getCurrentPage() + 1;
        $per_page = (int) $this->view
            ->getItemsPerPage();
        // @todo Maybe use a possible is views empty functionality.
        // Not every view has total_rows set, use view->result instead.
        $total = $this->view->total_rows ?? count($this->view->result);
        $label = Html::escape($this->view->storage
            ->label());
        // If there is no result the "start" and "current_record_count" should be
        // equal to 0. To have the same calculation logic, we use a "start offset"
        // to handle all the cases.
        $start_offset = empty($total) ? 0 : 1;
        if ($per_page === 0) {
            $page_count = 1;
            $start = $start_offset;
            $end = $total;
        }
        else {
            $page_count = (int) ceil($total / $per_page);
            $total_count = $current_page * $per_page;
            if ($total_count > $total) {
                $total_count = $total;
            }
            $start = ($current_page - 1) * $per_page + $start_offset;
            $end = $total_count;
        }
        $current_record_count = $end - $start + $start_offset;
        // Get the search information.
        $replacements = [];
        $replacements['@start'] = $start;
        $replacements['@end'] = $end;
        $replacements['@total'] = $total;
        $replacements['@label'] = $label;
        $replacements['@per_page'] = $per_page;
        $replacements['@current_page'] = $current_page;
        $replacements['@current_record_count'] = $current_record_count;
        $replacements['@page_count'] = $page_count;
        // Send the output.
        if (!empty($total) || !empty($this->options['empty'])) {
            $output .= str_replace(array_keys($replacements), array_values($replacements), $format);
            // Return as render array.
            return [
                '#markup' => $output,
            ];
        }
        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 Provide text for the administrative summary. 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 Provides the handler some groupby. 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 Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 5
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered 'broken'. 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 Calculates dependencies for the configured plugin. 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 Ensures that the main table for this handler is in the query. 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 Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. 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 Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Sets up any needed relationship. 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 Validate that the plugin is correct and can be saved. 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 Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 60
PluginBase::destroy public function Clears a plugin. 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 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::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::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::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validateOptionsForm public function Validate the options form. 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
Result::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides AreaPluginBase::buildOptionsForm
Result::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides AreaPluginBase::defineOptions
Result::query public function Add anything to the query that we might need to. Overrides HandlerBase::query
Result::render public function Render the area. Overrides AreaPluginBase::render
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.