class EnrolmentUserDisplayName in Open Social 8.9

Provides a 'EnrolmentUserDisplayName' user export row.

Plugin annotation

@UserExportPlugin(
 id = "enrolment_display_name",
 label = @Translation("Display name"),
 weight = -450,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\social_user_export\Plugin\UserExportPluginBase implements ContainerFactoryPluginInterface, UserExportPluginInterface uses StringTranslationTrait
    • class \Drupal\social_user_export\Plugin\UserExportPlugin\UserDisplayName
      • class \Drupal\social_event_an_enroll_enrolments_export\Plugin\UserExportPlugin\EnrolmentUserDisplayName

File

modules/social_features/social_event/modules/social_event_an_enroll_enrolments_export/src/Plugin/UserExportPlugin/EnrolmentUserDisplayName.php, line 22

Namespace

Drupal\social_event_an_enroll_enrolments_export\Plugin\UserExportPlugin

class EnrolmentUserDisplayName extends UserDisplayName {

  /**
   * The event an enroll manager.
   *
   * @var \Drupal\social_event_an_enroll\EventAnEnrollManager
   */
  protected $socialEventAnEnrollManager;

  /**
   * EnrolmentUserDisplayName constructor.
   *
   * @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_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter.
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\social_event_an_enroll\EventAnEnrollManager $social_event_an_enroll_manager
   *   The event an enroll manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, DateFormatterInterface $date_formatter, Connection $database, EventAnEnrollManager $social_event_an_enroll_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $date_formatter, $database);
    $this->socialEventAnEnrollManager = $social_event_an_enroll_manager;
  }

  /**
   * {@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('date.formatter'), $container
      ->get('database'), $container
      ->get('social_event_an_enroll.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getValue(UserInterface $entity) {
    if ($entity
      ->isAnonymous()) {
      $value = $this->socialEventAnEnrollManager
        ->getGuestName($this->configuration['entity'], FALSE);
      return $value ?: $this
        ->t('Guest');
    }
    return parent::getValue($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EnrolmentUserDisplayName::$socialEventAnEnrollManager	protected	property	The event an enroll manager.
EnrolmentUserDisplayName::create	public static	function	The create method. Overrides UserExportPluginBase::create
EnrolmentUserDisplayName::getValue	public	function	Returns the value. Overrides UserDisplayName::getValue
EnrolmentUserDisplayName::__construct	public	function	EnrolmentUserDisplayName constructor. Overrides UserExportPluginBase::__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.
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.
UserDisplayName::getHeader	public	function	Returns the header. Overrides UserExportPluginBase::getHeader
UserExportPluginBase::$database	public	property	The database.
UserExportPluginBase::$dateFormatter	public	property	The date formatter.
UserExportPluginBase::$entityTypeManager	public	property	The entity type manager.
UserExportPluginBase::getProfile	public	function	Get the Profile entity. Overrides UserExportPluginInterface::getProfile
UserExportPluginBase::profileGetAddressFieldValue	public	function	Returns the value for the address field and element within address. Overrides UserExportPluginInterface::profileGetAddressFieldValue
UserExportPluginBase::profileGetFieldValue	public	function	Returns the value of a field for a given profile. Overrides UserExportPluginInterface::profileGetFieldValue
UserExportPluginBase::profileGetTaxonomyFieldValue	public	function	Returns the values of a taxonomy reference field. Overrides UserExportPluginInterface::profileGetTaxonomyFieldValue