function ArgumentPluginBase::defaultActions

Provide a list of default behaviors for this argument if the argument is not present.

Override this method to provide additional (or fewer) default behaviors.

File

core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php, line 499

Class

ArgumentPluginBase

Base class for argument (contextual filter) handler plugins.

Namespace

Code

protected function defaultActions($which = NULL) {
    $defaults = [
        'ignore' => [
            'title' => $this->t('Display all results for the specified field'),
            'method' => 'defaultIgnore',
        ],
        'default' => [
            'title' => $this->t('Provide default value'),
            'method' => 'defaultDefault',
            'form method' => 'defaultArgumentForm',
            'has default argument' => TRUE,
            // This can only be used for missing argument, not validation failure.
'default only' => TRUE,
        ],
        'not found' => [
            'title' => $this->t('Hide view'),
            'method' => 'defaultNotFound',
            // This is a hard fail condition.
'hard fail' => TRUE,
        ],
        'summary' => [
            'title' => $this->t('Display a summary'),
            'method' => 'defaultSummary',
            'form method' => 'defaultSummaryForm',
            'style plugin' => TRUE,
        ],
        'empty' => [
            'title' => $this->t('Display contents of "No results found"'),
            'method' => 'defaultEmpty',
        ],
        'access denied' => [
            'title' => $this->t('Display "Access Denied"'),
            'method' => 'defaultAccessDenied',
        ],
    ];
    if ($this->view->display_handler
        ->hasPath()) {
        $defaults['not found']['title'] = $this->t('Show "Page not found"');
    }
    if ($which) {
        if (!empty($defaults[$which])) {
            return $defaults[$which];
        }
    }
    else {
        return $defaults;
    }
}