class ActivityFilterPersonalisedHomepage in Open Social 10.2.x
Same name and namespace in other branches
- 8.9 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.2 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.3 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.4 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.5 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.6 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.7 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 8.8 modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 10.3.x modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 10.0.x modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- 10.1.x modules/custom/activity_viewer/src/Plugin/views/filter/ActivityFilterPersonalisedHomepage.php \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
Filters activity for a personalised homepage.
Plugin annotation
@ViewsFilter("activity_filter_personalised_homepage");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\filter\FilterPluginBase implements CacheableDependencyInterface
- class \Drupal\activity_viewer\Plugin\views\filter\ActivityFilterPersonalisedHomepage
- class \Drupal\views\Plugin\views\filter\FilterPluginBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ActivityFilterPersonalisedHomepage
File
- modules/
custom/ activity_viewer/ src/ Plugin/ views/ filter/ ActivityFilterPersonalisedHomepage.php, line 20
Namespace
Drupal\activity_viewer\Plugin\views\filterView source
class ActivityFilterPersonalisedHomepage extends FilterPluginBase {
/**
* The group helper.
*
* @var \Drupal\social_group\SocialGroupHelperService
*/
protected $groupHelper;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Constructs a Handler object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\social_group\SocialGroupHelperService $group_helper
* The group helper.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, SocialGroupHelperService $group_helper, Connection $connection, ModuleHandlerInterface $module_handler) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->groupHelper = $group_helper;
$this->connection = $connection;
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('social_group.helper_service'), $container
->get('database'), $container
->get('module_handler'));
}
/**
* Not exposable.
*/
public function canExpose() {
return FALSE;
}
/**
* Filters out activity items the user is not allowed to see.
*
* The access to the activity items may be limited by the following:
* 1. Value in field_visibility_value on a Post entity.
* 2. Node access grants (this includes the field_node_visibility_value and
* the nodes in a closed group)
* 3. The comment or post is posted in a (closed) group.
*
* In addition to the condition used in this filter there may be some other
* filters active in the given view (e.g. destination).
*
* Probably want to extend this to entity access based on the node grant
* system when this is implemented.
* See https://www.drupal.org/node/777578
*/
public function query() {
$account = $this->view
->getUser();
$skip_roles = [
'administrator',
'contentmanager',
'sitemanager',
];
$hide_from_view = $nids = $pids = $cids = [];
// Skip filter for users that have full access to the site content.
if (!empty(array_intersect($skip_roles, $account
->getRoles()))) {
return;
}
$this
->ensureMyTable();
$group_memberships = $this->groupHelper
->getAllGroupsForUser($account
->id());
/** @var \Drupal\views\Plugin\views\query\Sql $filter_query */
$filter_query = $this->query;
$filter_query
->addTable('activity__field_activity_entity');
$filter_query
->addTable('activity__field_activity_recipient_group');
$filter_query
->addTable('activity__field_activity_recipient_user');
// Add queries.
$and_wrapper = new Condition('AND');
$or = new Condition('OR');
// Nodes: retrieve all the nodes to which the user has access.
if ($account
->hasPermission('access content')) {
$nids = $this
->getAvailableNodeIds($account, $group_memberships);
if (!empty($nids)) {
$node_access = $or
->andConditionGroup()
->condition('activity__field_activity_entity.field_activity_entity_target_type', 'node')
->condition('activity__field_activity_entity.field_activity_entity_target_id', $nids, 'IN');
$or
->condition($node_access);
}
else {
$hide_from_view[] = 'node';
}
}
// Posts: retrieve all the posts to which the user has access.
$pids = $this
->getAvailablePostIds($account, $group_memberships);
if (!empty($pids)) {
$post_access = $or
->andConditionGroup()
->condition('activity__field_activity_entity.field_activity_entity_target_type', 'post')
->condition('activity__field_activity_entity.field_activity_entity_target_id', $pids, 'IN');
$or
->condition($post_access);
}
else {
$hide_from_view[] = 'post';
}
// Comments: retrieve comments the user has access to.
if ($account
->hasPermission('access comments')) {
$cids = $this
->getAvailableCommentIds($nids, $pids);
if (!empty($cids)) {
$comments_access = $or
->andConditionGroup()
->condition('activity__field_activity_entity.field_activity_entity_target_type', 'comment')
->condition('activity__field_activity_entity.field_activity_entity_target_id', $cids, 'IN');
$or
->condition($comments_access);
}
else {
$hide_from_view[] = 'comment';
}
}
if (!empty($hide_from_view)) {
$and_wrapper
->condition('activity__field_activity_entity.field_activity_entity_target_type', $hide_from_view, 'NOT IN');
}
// Lets add all the or conditions to the Views query.
if (!empty($or
->conditions()[0])) {
$and_wrapper
->condition($or);
}
// Only activities which don't have direct user and group.
if ($account
->isAnonymous()) {
$an_access = new Condition('AND');
$an_user_target = new Condition('OR');
$an_user_target
->condition('activity__field_activity_recipient_user.field_activity_recipient_user_target_id', '0');
$an_user_target
->isNull('activity__field_activity_recipient_user.field_activity_recipient_user_target_id');
$an_access
->condition($an_user_target);
$an_access
->isNull('activity__field_activity_recipient_group.field_activity_recipient_group_target_id');
$and_wrapper
->condition($an_access);
}
else {
// Only activities which targeted to current user.
$lu_access = new Condition('AND');
$lu_user_target = new Condition('OR');
$lu_user_target
->condition('activity__field_activity_recipient_user.field_activity_recipient_user_target_id', (string) $account
->id());
$lu_user_target
->isNull('activity__field_activity_recipient_user.field_activity_recipient_user_target_id');
$lu_access
->condition($lu_user_target);
// Only activities which targeted to current user's groups.
$lu_group_target = new Condition('OR');
if (!empty($group_memberships)) {
$lu_group_target
->condition('activity__field_activity_recipient_group.field_activity_recipient_group_target_id', $group_memberships, 'IN');
}
$lu_group_target
->isNull('activity__field_activity_recipient_group.field_activity_recipient_group_target_id');
$lu_access
->condition($lu_group_target);
$and_wrapper
->condition($lu_access);
}
if (!empty($and_wrapper
->conditions()[0])) {
$filter_query
->addWhere('visibility', $and_wrapper);
}
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
$contexts = parent::getCacheContexts();
$contexts[] = 'user';
return $contexts;
}
/**
* Gets list of node IDs to which user has access.
*
* @param \Drupal\Core\Session\AccountInterface $user
* The current user.
* @param array $memberships
* List of user memberships.
*
* @return array
* List of node IDs.
*/
protected function getAvailableNodeIds(AccountInterface $user, array $memberships) {
$query = $this->connection
->select('node_field_data', 'nfd');
$query
->fields('nfd', [
'nid',
]);
$query
->leftJoin('node__field_content_visibility', 'nfcv', 'nfcv.entity_id = nfd.nid');
$query
->leftJoin('group_content_field_data', 'gcfd', 'gcfd.entity_id = nfd.nid');
$or = $query
->orConditionGroup();
if ($user
->isAuthenticated()) {
// Nodes community visibility.
$community_access = $or
->andConditionGroup()
->condition('nfcv.field_content_visibility_value', [
'community',
'public',
], 'IN')
->isNull('gcfd.entity_id');
$or
->condition($community_access);
// Node visibility by group.
if (count($memberships) > 0) {
$access_by_group = $or
->andConditionGroup();
$access_by_group
->condition('nfcv.field_content_visibility_value', [
'group',
'community',
'public',
], 'IN');
$access_by_group
->condition('gcfd.type', '%-group_node-%', 'LIKE');
$access_by_group
->condition('gcfd.gid', $memberships, 'IN');
$or
->condition($access_by_group);
}
}
else {
// Public nodes without group.
$anonymous_access = $or
->andConditionGroup()
->condition('nfcv.field_content_visibility_value', 'public')
->isNull('gcfd.entity_id');
$or
->condition($anonymous_access);
}
$or
->isNull('nfcv.entity_id');
$query
->condition($or);
// Alter query for custom conditions.
$this->moduleHandler
->alter('activity_viewer_available_nodes_query', $query, $user);
// Check node status and user access to it.
$node_status = [
'1',
];
if ($user
->hasPermission('view any unpublished content')) {
$node_status[] = '0';
}
$query
->condition('nfd.status', $node_status, 'IN');
$nids = $query
->execute()
->fetchCol();
return array_unique($nids);
}
/**
* Gets list of post IDs to which user has access.
*
* @param \Drupal\Core\Session\AccountInterface $user
* The current user.
* @param array $memberships
* List of user memberships.
*
* @return array
* List of post IDs.
*/
protected function getAvailablePostIds(AccountInterface $user, array $memberships) {
$query = $this->connection
->select('post_field_data', 'pfd');
$query
->fields('pfd', [
'id',
]);
$query
->leftJoin('post__field_visibility', 'pfv', 'pfv.entity_id = pfd.id');
$query
->leftJoin('post__field_recipient_group', 'pfrg', 'pfrg.entity_id = pfd.id');
$or = $query
->orConditionGroup();
if ($user
->isAuthenticated()) {
// Posts for authenticated users if has permission.
if ($user
->hasPermission('view community posts')) {
// Posts community visibility.
$community_access = $or
->andConditionGroup()
->condition('pfv.field_visibility_value', [
'0',
'1',
'2',
], 'IN')
->isNull('pfrg.entity_id');
$or
->condition($community_access);
}
// Posts related to the group where the user is a member.
if (count($memberships) > 0) {
$access_by_group = $or
->andConditionGroup();
$access_by_group
->condition('pfv.field_visibility_value', [
'0',
'1',
'2',
'3',
], 'IN');
$access_by_group
->condition('pfrg.field_recipient_group_target_id', $memberships, 'IN');
$or
->condition($access_by_group);
}
}
else {
// Public posts or do not have visibility settings.
if ($user
->hasPermission('view public posts')) {
$anonymous_access = $or
->andConditionGroup()
->condition('pfv.field_visibility_value', '1')
->isNull('pfrg.entity_id');
$or
->condition($anonymous_access);
}
}
$or
->isNull('pfv.entity_id');
$query
->condition($or);
// Alter query for custom conditions.
$this->moduleHandler
->alter('activity_viewer_available_posts_query', $query, $user);
// Check posts status and user access to it.
$post_status = [
'1',
];
if ($user
->hasPermission('view unpublished post entities')) {
$post_status[] = '0';
}
$query
->condition('pfd.status', $post_status, 'IN');
$pids = $query
->execute()
->fetchCol();
return array_unique($pids);
}
/**
* Gets list of comment IDs to which user has access.
*
* @param array $node_ids
* List of node IDs.
* @param array $post_ids
* List of post IDs.
*
* @return array
* List of comment IDs.
*/
protected function getAvailableCommentIds(array $node_ids, array $post_ids) {
$query = $this->connection
->select('comment_field_data', 'cfd');
$query
->fields('cfd', [
'cid',
]);
$or = $query
->orConditionGroup();
// Return empty array if any nodes or posts are not available.
if (empty($node_ids) && empty($post_ids)) {
return [];
}
// Comments related to available nodes.
if (!empty($node_ids)) {
$node_access = $or
->andConditionGroup();
$node_access
->condition('entity_type', 'node');
$node_access
->condition('entity_id', $node_ids, 'IN');
$or
->condition($node_access);
}
// Comments related to available posts.
if (!empty($post_ids)) {
$post_access = $or
->andConditionGroup();
$post_access
->condition('entity_type', 'post');
$post_access
->condition('entity_id', $post_ids, 'IN');
$or
->condition($post_access);
}
if (!empty($or
->conditions()[0])) {
$query
->condition($or);
}
$query
->condition('cfd.status', '1');
$cids = $query
->execute()
->fetchCol();
return array_unique($cids);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActivityFilterPersonalisedHomepage:: |
protected | property | The database connection. | |
ActivityFilterPersonalisedHomepage:: |
protected | property | The group helper. | |
ActivityFilterPersonalisedHomepage:: |
protected | property |
The module handler. Overrides HandlerBase:: |
|
ActivityFilterPersonalisedHomepage:: |
public | function |
Not exposable. Overrides FilterPluginBase:: |
|
ActivityFilterPersonalisedHomepage:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
ActivityFilterPersonalisedHomepage:: |
protected | function | Gets list of comment IDs to which user has access. | |
ActivityFilterPersonalisedHomepage:: |
protected | function | Gets list of node IDs to which user has access. | |
ActivityFilterPersonalisedHomepage:: |
protected | function | Gets list of post IDs to which user has access. | |
ActivityFilterPersonalisedHomepage:: |
public | function |
The cache contexts associated with this object. Overrides FilterPluginBase:: |
|
ActivityFilterPersonalisedHomepage:: |
public | function |
Filters out activity items the user is not allowed to see. Overrides FilterPluginBase:: |
|
ActivityFilterPersonalisedHomepage:: |
public | function |
Constructs a Handler object. Overrides HandlerBase:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FilterPluginBase:: |
protected | property | Disable the possibility to force a single value. | 6 |
FilterPluginBase:: |
public | property | Disable the possibility to allow an exposed input to be optional. | |
FilterPluginBase:: |
public | property | Contains the information of the selected item in a grouped filter. | |
FilterPluginBase:: |
public | property | Disable the possibility to use operators. | 1 |
FilterPluginBase:: |
public | property | Contains the operator which is used on the query. | |
FilterPluginBase:: |
public | property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | |
FilterPluginBase:: |
public | function |
Determines if the input from a filter should change the generated query. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
FilterPluginBase:: |
public | function |
Display the filter on the administrative summary. Overrides HandlerBase:: |
10 |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow the use of (string) "0". | |
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. | |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Options form subform for exposed filter options. Overrides HandlerBase:: |
4 |
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Validate the build group options form. | |
FilterPluginBase:: |
public | function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
protected | function | Builds wrapper for value and operator forms. | |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
FilterPluginBase:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
FilterPluginBase:: |
public | function |
Provide default options for exposed filters. Overrides HandlerBase:: |
4 |
FilterPluginBase:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides HandlerBase:: |
6 |
FilterPluginBase:: |
public | function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
FilterPluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
FilterPluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
1 |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
FilterPluginBase:: |
protected | function | Determines if the given grouped filter entry has a valid value. | 1 |
FilterPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: |
4 |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Options form subform for setting the operator. | 6 |
FilterPluginBase:: |
public | function | Provide a list of options for the default operator form. | 5 |
FilterPluginBase:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | |
FilterPluginBase:: |
public | function |
Simple submit handler. Overrides PluginBase:: |
|
FilterPluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides PluginBase:: |
|
FilterPluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Validates a filter identifier. | |
FilterPluginBase:: |
public | function |
Simple validate handler. Overrides PluginBase:: |
1 |
FilterPluginBase:: |
protected | function | Options form subform for setting options. | 7 |
FilterPluginBase:: |
protected | function | Perform any necessary changes to the form values prior to storage. | 1 |
FilterPluginBase:: |
protected | function | Validate the options form. | 3 |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | Where the $query object will reside. | 7 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
protected | property | The views data service. | |
HandlerBase:: |
public | function |
Check whether given user has access to this handler. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public | function |
Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public static | function |
Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Determines if the handler is considered 'broken', meaning it's a
placeholder used when a handler can't be found. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
10 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function |
Ensure the main table for this handler is in the query. This is used
a lot. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | 2 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | 2 |
HandlerBase:: |
public | function |
Determines the entity type used by this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Get the join object that should be used for this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets the module handler. | |
HandlerBase:: |
public static | function |
Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets views data service. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function |
Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Run before the view is built. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function |
Sanitize the value for output. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Sets the module handler. | |
HandlerBase:: |
public | function |
Called just prior to query(), this lets a handler set up any relationship
it needs. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | ||
HandlerBase:: |
public | function |
Shortcut to display the exposed options form. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Submit the exposed handler form. | |
HandlerBase:: |
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:: |
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:: |
public | function | Calculates options stored on the handler. | 1 |
HandlerBase:: |
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:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 13 |
HandlerBase:: |
public | function | Validate the exposed handler form. | 4 |
HandlerBase:: |
public | function | Validate the options form. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |