You are here

interface SocialAddToCalendarInterface in Open Social 10.1.x

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_event/modules/social_event_addtocal/src/Plugin/SocialAddToCalendarInterface.php \Drupal\social_event_addtocal\Plugin\SocialAddToCalendarInterface
  2. 10.3.x modules/social_features/social_event/modules/social_event_addtocal/src/Plugin/SocialAddToCalendarInterface.php \Drupal\social_event_addtocal\Plugin\SocialAddToCalendarInterface
  3. 10.0.x modules/social_features/social_event/modules/social_event_addtocal/src/Plugin/SocialAddToCalendarInterface.php \Drupal\social_event_addtocal\Plugin\SocialAddToCalendarInterface
  4. 10.2.x modules/social_features/social_event/modules/social_event_addtocal/src/Plugin/SocialAddToCalendarInterface.php \Drupal\social_event_addtocal\Plugin\SocialAddToCalendarInterface

Defines an interface for Social add to calendar plugins.

Hierarchy

Expanded class hierarchy of SocialAddToCalendarInterface

All classes that implement SocialAddToCalendarInterface

1 file declares its use of SocialAddToCalendarInterface
social_event_addtocal.module in modules/social_features/social_event/modules/social_event_addtocal/social_event_addtocal.module
Contains Social Add To Calendar module.

File

modules/social_features/social_event/modules/social_event_addtocal/src/Plugin/SocialAddToCalendarInterface.php, line 11

Namespace

Drupal\social_event_addtocal\Plugin
View source
interface SocialAddToCalendarInterface extends PluginInspectionInterface {

  /**
   * Returns plugin name for label.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Plugin name.
   */
  public function getName();

  /**
   * Returns the 'Add to calendar' link.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node entity.
   *
   * @return \Drupal\Core\Url
   *   Url object.
   */
  public function generateUrl(NodeInterface $node);

  /**
   * Returns array of event settings for url options.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node entity.
   *
   * @return array
   *   Array of settings.
   */
  public function generateSettings(NodeInterface $node);

  /**
   * Returns array of event dates for calendar.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node entity.
   *
   * @return array
   *   Array of dates values.
   */
  public function getEventDates(NodeInterface $node);

  /**
   * Returns the event description for calendar.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node entity.
   *
   * @return string
   *   Event description.
   */
  public function getEventDescription(NodeInterface $node);

  /**
   * Returns the event location for calendar.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node entity.
   *
   * @return string
   *   Event location.
   */
  public function getEventLocation(NodeInterface $node);

}

Members

Namesort descending Modifiers Type Description Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SocialAddToCalendarInterface::generateSettings public function Returns array of event settings for url options. 1
SocialAddToCalendarInterface::generateUrl public function Returns the 'Add to calendar' link. 1
SocialAddToCalendarInterface::getEventDates public function Returns array of event dates for calendar. 1
SocialAddToCalendarInterface::getEventDescription public function Returns the event description for calendar. 1
SocialAddToCalendarInterface::getEventLocation public function Returns the event location for calendar. 1
SocialAddToCalendarInterface::getName public function Returns plugin name for label. 1