class Event in Open Social 8

Event Plugin for demo content.

Plugin annotation

@DemoContent(
  id = "event",
  label = @Translation("Event"),
  source = "content/entity/event.yml",
  entity_type = "node"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\social_demo\DemoContent implements DemoContentInterface
      • class \Drupal\social_demo\DemoNode
        • class \Drupal\social_demo\Plugin\DemoContent\Event

2 string references to 'Event'

field.field.event_enrollment.event_enrollment.field_event.yml in modules/social_features/social_event/config/install/field.field.event_enrollment.event_enrollment.field_event.yml

modules/social_features/social_event/config/install/field.field.event_enrollment.event_enrollment.field_event.yml

node.type.event.yml in modules/social_features/social_event/config/install/node.type.event.yml

modules/social_features/social_event/config/install/node.type.event.yml

File

modules/custom/social_demo/src/Plugin/DemoContent/Event.php, line 24

Namespace

Drupal\social_demo\Plugin\DemoContent

class Event extends DemoNode {

  /**
   * The file storage.
   *
   * @var \Drupal\file\FileStorageInterface
   */
  protected $fileStorage;

  /**
   * The taxonomy term storage.
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $termStorage;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DemoContentParserInterface $parser, UserStorageInterface $user_storage, EntityStorageInterface $group_storage, FileStorageInterface $file_storage, TermStorageInterface $term_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $parser, $user_storage, $group_storage);
    $this->fileStorage = $file_storage;
    $this->termStorage = $term_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('social_demo.yaml_parser'), $container
      ->get('entity.manager')
      ->getStorage('user'), $container
      ->get('entity.manager')
      ->getStorage('group'), $container
      ->get('entity.manager')
      ->getStorage('file'), $container
      ->get('entity.manager')
      ->getStorage('taxonomy_term'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntry(array $item) {
    $entry = parent::getEntry($item);
    $entry['field_event_address'] = $item['field_event_address'];
    $entry['field_event_date'] = $this
      ->createEventDate($item['field_event_date']);
    $entry['field_event_date_end'] = $this
      ->createEventDate($item['field_event_date_end']);
    $entry['field_event_location'] = $item['field_event_location'];
    $entry['field_content_visibility'] = $item['field_content_visibility'];

    // Load image by uuid and set to node.
    if (!empty($item['field_event_image'])) {
      $entry['field_event_image'] = $this
        ->prepareImage($item['field_event_image']);
    }

    // Load attachments to node.
    if (!empty($item['field_files'])) {
      $entry['field_files'] = $this
        ->prepareAttachment($item['field_files']);
    }
    if (\Drupal::moduleHandler()
      ->moduleExists('social_event_type') && !empty($item['field_event_type'])) {
      $entry['field_event_type'] = $this
        ->prepareEventType($item['field_event_type']);
    }

    // Possibility to add event managers (if the module is enabled)
    if (\Drupal::moduleHandler()
      ->moduleExists('social_event_managers') && !empty($item['field_event_managers'])) {
      $entry['field_event_managers'] = $this
        ->prepareEventManagers($item['field_event_managers']);
    }
    return $entry;
  }

  /**
   * Function to calculate the date.
   */
  protected function createEventDate($date_string) {

    // Split from delimiter.
    $timestamp = explode('|', $date_string);
    $date = strtotime($timestamp[0]);
    $date = date('Y-m-d', $date) . 'T' . $timestamp[1] . ':00';
    return $date;
  }

  /**
   * Prepares data about an image of node.
   *
   * @param string $uuid
   *   The uuid for the image.
   *
   * @return array|null
   *   Returns an array or null.
   */
  protected function prepareImage($uuid) {
    $value = NULL;
    $files = $this->fileStorage
      ->loadByProperties([
      'uuid' => $uuid,
    ]);
    if ($files) {
      $value = [
        [
          'target_id' => current($files)
            ->id(),
        ],
      ];
    }
    return $value;
  }

  /**
   * Returns reference to attachment, possibly with a description.
   *
   * @param array $files
   *   Array with UUIDs of files.
   *
   * @return array|null
   *   Array containing related files or NULL.
   */
  protected function prepareAttachment(array $files) {
    $attachments = NULL;
    foreach ($files as $file) {
      $description = '';

      // If it is an array, this means we also have a description.
      if (is_array($file)) {
        $uuid = key($file);
        $description = current($file);
      }
      else {
        $uuid = $file;
      }
      $object = $this->fileStorage
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      if ($object) {
        $properties = [
          'target_id' => current($object)
            ->id(),
          'description' => $description,
        ];
        $attachments[] = $properties;
      }
    }
    return $attachments;
  }

  /**
   * Returns taxonomy term id.
   *
   * @param string $uuid
   *   The uuid.
   *
   * @return array|null
   *   Returns an array or null.
   */
  protected function prepareEventType($uuid) {
    $value = NULL;
    $terms = $this->termStorage
      ->loadByProperties([
      'uuid' => $uuid,
    ]);
    if ($terms) {
      $value = [
        [
          'target_id' => current($terms)
            ->id(),
        ],
      ];
    }
    return $value;
  }

  /**
   * Returns event managers.
   *
   * @param array $managers
   *   An array of uuids.
   *
   * @return array|null
   *   Returns an array or null.
   */
  protected function prepareEventManagers(array $managers) {
    $values = NULL;
    foreach ($managers as $uuid) {

      // Load the user(s) by the given uuid(s).
      $load = $this->userStorage
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      $account = current($load);
      if ($account instanceof User) {
        $properties = [
          'target_id' => $account
            ->id(),
        ];
        $values[] = $properties;
      }
    }
    return $values;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DemoContent::$content	protected	property	Contains the created content.
DemoContent::$data	protected	property	Contains data from a file.
DemoContent::$entityStorage	protected	property	Contains the entity storage.
DemoContent::$parser	protected	property	Parser.
DemoContent::$profile	protected	property	Profile.
DemoContent::checkMentionOrLinkByUuid	protected	function	Extract the mention from the content by [~Uuid].
DemoContent::count	public	function	Returns quantity of created items. Overrides DemoContentInterface::count	1
DemoContent::fetchData	protected	function	Gets the data from a file.
DemoContent::getModule	public	function	Returns the module name. Overrides DemoContentInterface::getModule
DemoContent::getProfile	public	function	Returns the profile. Overrides DemoContentInterface::getProfile
DemoContent::getSource	public	function	Returns the file name. Overrides DemoContentInterface::getSource
DemoContent::loadByUuid	protected	function	Load entity by uuid.
DemoContent::removeContent	public	function	Removes content. Overrides DemoContentInterface::removeContent
DemoContent::setEntityStorage	public	function	Set entity storage. Overrides DemoContentInterface::setEntityStorage
DemoContent::setProfile	public	function	Sets the used profile. Overrides DemoContentInterface::setProfile
DemoNode::$groupStorage	protected	property	The entity storage.
DemoNode::$userStorage	protected	property	The user storage.
DemoNode::createContent	public	function	Creates content. Overrides DemoContentInterface::createContent
DemoNode::createDate	protected	function	Converts a date in the correct format.
DemoNode::createFollow	public	function	The function that checks and creates a follow on an entity.
DemoNode::createGroupContent	public	function	Creates a group content.
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
Event::$fileStorage	protected	property	The file storage.
Event::$termStorage	protected	property	The taxonomy term storage.
Event::create	public static	function	Creates an instance of the plugin. Overrides DemoNode::create
Event::createEventDate	protected	function	Function to calculate the date.
Event::getEntry	protected	function	Makes an array with data of an entity. Overrides DemoNode::getEntry
Event::prepareAttachment	protected	function	Returns reference to attachment, possibly with a description.
Event::prepareEventManagers	protected	function	Returns event managers.
Event::prepareEventType	protected	function	Returns taxonomy term id.
Event::prepareImage	protected	function	Prepares data about an image of node.
Event::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides DemoNode::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.