class Platform in Social Media Links Block and Field 8.2

Defines a platform item annotation object.

Plugin Namespace: Plugin\SocialMediaLinks\Platform.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\social_media_links\Annotation\Platform

See also

\Drupal\social_media_links\SocialMediaLinksPlatformManager

Plugin API

4 string references to 'Platform'

SocialMediaLinksBlock::blockForm in src/Plugin/Block/SocialMediaLinksBlock.php

SocialMediaLinksFieldItem::fieldSettingsForm in modules/social_media_links_field/src/Plugin/Field/FieldType/SocialMediaLinksFieldItem.php

Returns a form for the field-level settings.

SocialMediaLinksFieldItem::propertyDefinitions in modules/social_media_links_field/src/Plugin/Field/FieldType/SocialMediaLinksFieldItem.php

Defines field item properties.

SocialMediaLinksPlatforms::processElement in modules/social_media_links_field/src/Element/SocialMediaLinksPlatforms.php

Process the platform form element.

28 classes are annotated with Platform

Amazon in src/Plugin/SocialMediaLinks/Platform/Amazon.php

Provides 'amazon' platform.

Behance in src/Plugin/SocialMediaLinks/Platform/Behance.php

Provides 'behance' platform.

BitBucket in src/Plugin/SocialMediaLinks/Platform/BitBucket.php

Provides 'BitBucket' platform.

Contact in src/Plugin/SocialMediaLinks/Platform/Contact.php

Provides 'contact' platform.

Drupal in src/Plugin/SocialMediaLinks/Platform/Drupal.php

Provides 'drupal' platform.

... See full list

File

src/Annotation/Platform.php, line 17

Namespace

Drupal\social_media_links\Annotation

class Platform extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * Optional: The name of the icon.
   *
   * In most cases, the iconName is equal to the ID of the platform.
   * If no iconName is set, we use the ID.
   *
   * @var string
   */
  public $iconName;

  /**
   * The name of the platform.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $name;

  /**
   * The description for the platform value field.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $fieldDescription;

  /**
   * The url prefix of the platform.
   *
   * @var string
   */
  public $urlPrefix;

  /**
   * The url suffix of the platform.
   *
   * @var string
   */
  public $urlSuffix;

}

Members

Name	Modifiers	Type	Description	Overrides
Platform::$fieldDescription	public	property	The description for the platform value field.
Platform::$iconName	public	property	Optional: The name of the icon.
Platform::$id	public	property	The plugin ID.
Platform::$name	public	property	The name of the platform.
Platform::$urlPrefix	public	property	The url prefix of the platform.
Platform::$urlSuffix	public	property	The url suffix of the platform.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2