class NotificationWidgetUpdateResource in Notifications widget 8

Provides a resource to get update the status of notification items.

Plugin annotation


@RestResource(
  id = "notifications_update_widget",
  label = @Translation("Update notifications items"),
  uri_paths = {
    "https://www.drupal.org/link-relations/create" = "/api/notification_update"
  }
)

View source

class NotificationWidgetUpdateResource extends ResourceBase {

  /**
   * The Database Connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * A current user instance.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * Constructs a Drupal\rest\Plugin\ResourceBase 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 array $serializer_formats
   *   The available serialization formats.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   A current user instance.
   * @param \Drupal\Core\Database\Connection $database
   *   Database Connection.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $serializer_formats, LoggerInterface $logger, AccountProxyInterface $current_user, Connection $database) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
    $this->currentUser = $current_user;
    $this->database = $database;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->getParameter('serializer.formats'), $container
      ->get('logger.factory')
      ->get('notification-update'), $container
      ->get('current_user'), $container
      ->get('database'), $container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * {@inheritdoc}
   */
  public function post($notificationData) {
    $result = [];

    // Get logged user session.
    $currentUser = $this->currentUser;
    $uid = $currentUser
      ->id();

    // Use current user after pass authentication to validate access.
    if (!$this->currentUser
      ->hasPermission('access content')) {
      throw new AccessDeniedHttpException();
    }
    $action = $notificationData['notification_action'];
    $id = is_numeric($notificationData['nasId']) ? $notificationData['nasId'] : NULL;
    $notificationId = $notificationData['notiId'];
    switch ($action) {
      case 'read':
        $keys = [
          'id' => $id,
        ];
        $fields = [
          'notification_id' => $notificationId,
          'uid' => $uid,
          'status' => 1,
          'created' => \Drupal::time()
            ->getRequestTime(),
        ];
        $tableName = 'notifications_actions';
        break;
      case 'delete':
        $keys = [
          'id' => $id,
        ];
        $fields = [
          'notification_id' => $notificationId,
          'uid' => $uid,
          'status' => 2,
          'created' => \Drupal::time()
            ->getRequestTime(),
        ];
        $tableName = 'notifications_actions';
        break;
      case 'clearall':
        $keys = [
          'id' => NULL,
        ];
        $fields = [
          'notification_id' => $notificationId,
          'uid' => $uid,
          'created' => \Drupal::time()
            ->getRequestTime(),
        ];
        $tableName = 'notifications_clear_all';
        break;
    }
    try {
      $this->database
        ->merge($tableName)
        ->key($keys)
        ->fields($fields)
        ->execute();
      $result = [
        'status' => $this
          ->t('success updated'),
      ];
    } catch (Exception $e) {

      // Exception handling if something else gets thrown.
      $this->loggerFactory
        ->error($e
        ->getMessage());
    }
    $response = new ResourceResponse($result);
    $response
      ->addCacheableDependency($result);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
NotificationWidgetUpdateResource::$currentUser	protected	property	A current user instance.
NotificationWidgetUpdateResource::$database	protected	property	The Database Connection.
NotificationWidgetUpdateResource::create	public static	function	Creates an instance of the plugin. Overrides ResourceBase::create
NotificationWidgetUpdateResource::post	public	function
NotificationWidgetUpdateResource::__construct	public	function	Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides ResourceBase::__construct
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.
ResourceBase::$logger	protected	property	A logger instance.
ResourceBase::$serializerFormats	protected	property	The available serialization formats.
ResourceBase::availableMethods	public	function	Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods	1
ResourceBase::getBaseRoute	protected	function	Gets the base route for a particular method.	2
ResourceBase::getBaseRouteRequirements	protected	function	Gets the base route requirements for a particular method.	1
ResourceBase::permissions	public	function	Implements ResourceInterface::permissions(). Overrides ResourceInterface::permissions	2
ResourceBase::requestMethods	protected	function	Provides predefined HTTP request methods.
ResourceBase::routes	public	function	Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface::routes
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.

You are here

class NotificationWidgetUpdateResource in Notifications widget 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation