class UserProfilePage in Context 8.4

Provides a 'User profile page status' condition.

Plugin annotation


@Condition(
  id = "user_status",
  label = @Translation("User profile pages"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user", label = @Translation("User")),
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Executable\ExecutablePluginBase implements ExecutableInterface
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\context\Plugin\Condition\UserProfilePage implements ContainerFactoryPluginInterface

Expanded class hierarchy of UserProfilePage

File

src/Plugin/Condition/UserProfilePage.php, line 25

Namespace

Drupal\context\Plugin\Condition

View source

class UserProfilePage extends ConditionPluginBase implements ContainerFactoryPluginInterface {

  /**
   * Service current_route_match.
   *
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  private $currentRouteMatch;

  /**
   * Service entity_field.manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  private $entityFieldManager;

  /**
   * Service current_user.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  private $currentUser;

  /**
   * UserProfilePage constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CurrentRouteMatch $currentRouteMatch, EntityFieldManager $entityFieldManager, AccountProxy $currentUser) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentRouteMatch = $currentRouteMatch;
    $this->entityFieldManager = $entityFieldManager;
    $this->currentUser = $currentUser;
  }

  /**
   * UserProfilePage create function.
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'), $container
      ->get('entity_field.manager'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $user_fields = $this->entityFieldManager
      ->getFieldDefinitions('user', 'user');
    $ufields = [];
    foreach ($user_fields as $field_key => $field_value) {
      $ufields[$field_key] = $field_key;
    }
    $configuration = $this
      ->getConfiguration();
    $options = [
      'viewing_profile' => $this
        ->t('Viewing any user profile.'),
      'logged_viewing_profile' => $this
        ->t('Logged in and viewing any user profile.'),
      'own_page_true' => $this
        ->t('User viewing own profile.'),
      'field_value' => $this
        ->t('Has a value in selected user field'),
    ];
    $form['user_status'] = [
      '#title' => $this
        ->t('User status'),
      '#description' => 'If nothing is checked, the evaluation will return TRUE. If more than one option is checked, the evaluation will return TRUE if any of the options matches the condition.',
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => isset($configuration['user_status']) ? $configuration['user_status'] : [],
    ];
    $form['user_fields'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('User field'),
      '#options' => $ufields,
      '#default_value' => isset($configuration['user_fields']) ? $configuration['user_fields'] : FALSE,
      '#states' => [
        // Show this field only if the 'field_value' is selected above.
        'visible' => [
          ':input[name*="[user_status][user_status][field_value]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'user_status' => [],
      'user_fields' => 'uid',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['user_status'] = $form_state
      ->getValue('user_status');
    $this->configuration['user_fields'] = $form_state
      ->getValue('user_fields');
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    if (empty($this->configuration['user_status'])) {
      return $this
        ->t('No user status field is selected.');
    }
    return t('Select user profile page status');
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $route = $this->currentRouteMatch
      ->getCurrentRouteMatch();
    $configuration = $this
      ->getConfiguration();

    // Check if no option is checked.
    if (empty($configuration['user_status']) || !array_filter($configuration['user_status'])) {
      return TRUE;
    }
    else {
      foreach ($configuration['user_status'] as $key => $value) {
        if (empty($value)) {
          unset($configuration['user_status'][$key]);
        }
      }
      $user_conf = $configuration['user_status'];
    }

    // Match all entity.user.* routes having user parameter,
    // which include regular user profile view (entity.user.canonical),
    // user edit form (entity.user.edit_form),...
    if (strpos($route
      ->getRouteName(), 'entity.user.') === 0) {
      $user_id = $this->currentRouteMatch
        ->getRawParameter('user');
      if ($user_id === NULL) {
        return FALSE;
      }
      if (in_array("viewing_profile", $user_conf)) {
        return TRUE;
      }
      else {
        if (in_array("logged_viewing_profile", $user_conf) && $this->currentUser
          ->isAuthenticated()) {
          return TRUE;
        }
        else {
          if (in_array("own_page_true", $user_conf) && $this->currentUser
            ->isAuthenticated() && $user_id == $this->currentUser
            ->id()) {
            return TRUE;
          }
          else {
            if (in_array("field_value", $user_conf)) {
              $user = User::load($user_id);

              // Check if field is entity_reference or normal field with values.
              $field_target = $user
                ->get($configuration['user_fields'])->target_id;
              if ($field_target) {
                $field = $field_target;
              }
              else {
                $field = $user
                  ->get($configuration['user_fields'])->value;
              }

              // Condition check.
              if ($field || !$field == 0) {
                return TRUE;
              }
            }
          }
        }
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionPluginBase::$executableManager	protected	property	The condition manager to proxy execute calls through.
ConditionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated	public	function	Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager	public	function	Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
ExecutablePluginBase::getConfig	public	function	Gets all configuration values.
ExecutablePluginBase::getConfigDefinition	public	function	Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions	public	function	Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig	public	function	Sets the value of a particular configuration option.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::isConfigurable	public	function	Determines if the plugin is configurable.
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
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2
UserProfilePage::$currentRouteMatch	private	property	Service current_route_match.
UserProfilePage::$currentUser	private	property	Service current_user.
UserProfilePage::$entityFieldManager	private	property	Service entity_field.manager.
UserProfilePage::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
UserProfilePage::create	public static	function	UserProfilePage create function. Overrides ContainerFactoryPluginInterface::create
UserProfilePage::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
UserProfilePage::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
UserProfilePage::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
UserProfilePage::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
UserProfilePage::__construct	public	function	UserProfilePage constructor. Overrides ConditionPluginBase::__construct

You are here

class UserProfilePage in Context 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation