You are here

Home » API reference » Booking and Availability Management API 8 » EventsIndex.php

class EventsIndex in Booking and Availability Management API 8

Same name in this branch
  1. 8 src/Plugin/Deriver/EventsIndex.php \Drupal\bat_api\Plugin\Deriver\EventsIndex
  2. 8 src/Plugin/ServiceDefinition/EventsIndex.php \Drupal\bat_api\Plugin\ServiceDefinition\EventsIndex

Plugin annotation


@ServiceDefinition(
  id = "events_index",
  methods = {
    "GET"
  },
  translatable = true,
  deriver = "\Drupal\bat_api\Plugin\Deriver\EventsIndex"
)

Hierarchy

Expanded class hierarchy of EventsIndex

File

src/Plugin/ServiceDefinition/EventsIndex.php, line 35
Contains \Drupal\bat_api\Plugin\ServiceDefinition\EventsIndex.php

Namespace

Drupal\bat_api\Plugin\ServiceDefinition
View source 
class EventsIndex extends ServiceDefinitionBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * @var \Drupal\bat_fullcalendar\FullCalendarFixedStateEventFormatter
   */
  protected $fixedStateEventFormatter;

  /**
   * @var \Drupal\bat_fullcalendar\FullCalendarOpenStateEventFormatter
   */
  protected $openStateEventFormatter;

  /**
   * @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\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity manager.
   * @param \Drupal\bat_fullcalendar\FullCalendarFixedStateEventFormatter $fixedStateEventFormatter
   * @param \Drupal\bat_fullcalendar\FullCalendarOpenStateEventFormatter $openStateEventFormatter
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_manager, AccountInterface $current_user, FullCalendarFixedStateEventFormatter $fixedStateEventFormatter, FullCalendarOpenStateEventFormatter $openStateEventFormatter) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_manager;
    $this->currentUser = $current_user;
    $this->fixedStateEventFormatter = $fixedStateEventFormatter;
    $this->openStateEventFormatter = $openStateEventFormatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('current_user'), $container
      ->get('bat_fullcalendar.fixed_state_event_formatter'), $container
      ->get('bat_fullcalendar.open_state_event_formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

  /**
   * {@inheritdoc}
   */
  public function processRequest(Request $request, RouteMatchInterface $route_match, SerializerInterface $serializer) {
    $target_ids = $request->query
      ->get('target_ids');
    $target_types = $request->query
      ->get('target_types');
    $target_entity_type = $request->query
      ->get('target_entity_type');
    $start_date = $request->query
      ->get('start_date');
    $end_date = $request->query
      ->get('end_date');
    $event_types = $request->query
      ->get('event_types');
    $target_types = array_filter(explode(',', $target_types));
    $types = array_filter(explode(',', $event_types));
    $events_json = [];
    foreach ($types as $type) {
      $database = Database::getConnectionInfo('default');
      $prefix = isset($database['default']['prefix']['default']) ? $database['default']['prefix']['default'] : '';
      $event_store = new DrupalDBStore($type, DrupalDBStore::BAT_EVENT, $prefix);
      $start_date_object = new \DateTime($start_date);
      $end_date_object = new \DateTime($end_date);
      $today = new \DateTime();
      if (!$this->currentUser
        ->hasPermission('view past event information') && $today > $start_date_object) {
        if ($today > $end_date_object) {
          return [];
        }
        $start_date_object = $today;
      }
      $ids = explode(',', $target_ids);
      $units = [];
      foreach ($ids as $id) {
        if ($target_entity = $this->entityTypeManager
          ->getStorage($target_entity_type)
          ->load($id)) {
          if (in_array($target_entity->type, $target_types) || empty($target_types)) {

            // Setting the default value to 0 since we are dealing with the events array
            // so getting event IDs.
            $units[] = new Unit($id, 0);
          }
        }
      }
      if (!empty($units)) {
        $event_calendar = new Calendar($units, $event_store);
        $event_ids = $event_calendar
          ->getEvents($start_date_object, $end_date_object);
        $bat_event_type = bat_event_type_load($type);
        if ($bat_event_type
          ->getFixedEventStates()) {
          $event_formatter = $this->fixedStateEventFormatter;
        }
        else {
          $event_formatter = $this->openStateEventFormatter;
        }
        $event_formatter
          ->setEventType($bat_event_type);
        foreach ($event_ids as $unit_id => $unit_events) {
          foreach ($unit_events as $key => $event) {
            $events_json[] = [
              'id' => (string) $key . $unit_id,
              'bat_id' => $event
                ->getValue(),
              'resourceId' => 'S' . $unit_id,
            ] + $event
              ->toJson($event_formatter);
          }
        }
      }
    }
    return $events_json;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
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
EventsIndex::$currentUser protected property The current user.
EventsIndex::$entityTypeManager protected property The entity type manager.
EventsIndex::$fixedStateEventFormatter protected property
EventsIndex::$openStateEventFormatter protected property
EventsIndex::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EventsIndex::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
EventsIndex::processRequest public function Processes the request and returns an array of data as appropriate. Overrides ServiceDefinitionInterface::processRequest
EventsIndex::__construct public function Overrides ContextAwarePluginBase::__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.
ServiceDefinitionBase::getArguments public function Returns an array of service request arguments. Overrides ServiceDefinitionInterface::getArguments
ServiceDefinitionBase::getCategory public function Returns a translated string for the category. Overrides ServiceDefinitionInterface::getCategory
ServiceDefinitionBase::getDescription public function Returns a translated description for the constraint description. Overrides ServiceDefinitionInterface::getDescription
ServiceDefinitionBase::getMethods public function Return an array of allowed methods. Overrides ServiceDefinitionInterface::getMethods
ServiceDefinitionBase::getPath public function Returns the appended path for the service. Overrides ServiceDefinitionInterface::getPath
ServiceDefinitionBase::getTitle public function Returns a translated string for the service title. Overrides ServiceDefinitionInterface::getTitle
ServiceDefinitionBase::processResponse public function Allow plugins to alter the response object before it is returned. Overrides ServiceDefinitionInterface::processResponse
ServiceDefinitionBase::processRoute public function Checks access for the ServiceDefintion. Overrides ServiceDefinitionInterface::processRoute 7
ServiceDefinitionBase::supportsTranslation public function Returns a boolean if this service definition supports translations. Overrides ServiceDefinitionInterface::supportsTranslation
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.
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