class NodeSubmittedBy in Display Suite 8.4

Plugin that renders the submitted by field.

Plugin annotation

@DsField(
  id = "node_submitted_by",
  title = @Translation("Submitted by"),
  entity_type = "node",
  provider = "node"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ds\Plugin\DsField\DsFieldBase implements ConfigurableInterface, DependentPluginInterface, DsFieldInterface
      • class \Drupal\ds\Plugin\DsField\Date
        • class \Drupal\ds\Plugin\DsField\Node\NodeSubmittedBy

File

src/Plugin/DsField/Node/NodeSubmittedBy.php, line 22

Namespace

Drupal\ds\Plugin\DsField\Node

class NodeSubmittedBy extends Date {

  /**
   * Drupal core Render service.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

  /**
   * Constructs a Display Suite field plugin.
   */
  public function __construct($configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, Renderer $renderer, DateFormatterInterface $date_service, TimeInterface $time_service) {
    $this->renderer = $renderer;
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $date_service, $time_service);
  }

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

  /**
   * {@inheritdoc}
   */
  public function build() {
    $field = $this
      ->getFieldConfiguration();

    /* @var $node \Drupal\node\NodeInterface */
    $node = $this
      ->entity();

    /* @var $account \Drupal\user\UserInterface */
    $account = $node
      ->getOwner();
    $date_format = str_replace('ds_post_date_', '', $field['formatter']);
    $user_name = [
      '#theme' => 'username',
      '#account' => $account,
    ];
    return [
      '#markup' => $this
        ->t('Submitted by @user on @date.', [
        '@user' => $this->renderer
          ->render($user_name),
        '@date' => $this->dateFormatter
          ->format($this
          ->entity()->created->value, $date_format),
      ]),
      '#cache' => [
        'tags' => $account
          ->getCacheTags(),
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Date::$dateFormatter	protected	property	The date formatter service.
Date::$entityTypeManager	protected	property	The EntityDisplayRepository service.
Date::$timeService	protected	property	The time service.
Date::formatters	public	function	Returns a list of possible formatters for this field. Overrides DsFieldBase::formatters
Date::getRenderKey	public	function	Returns the entity render key for this field.	4
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
DsFieldBase::bundle	public	function	Gets the current bundle. Overrides DsFieldInterface::bundle
DsFieldBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DsFieldBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	5
DsFieldBase::entity	public	function	Gets the current entity. Overrides DsFieldInterface::entity
DsFieldBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
DsFieldBase::getEntityTypeId	public	function	Gets the current entity type. Overrides DsFieldInterface::getEntityTypeId
DsFieldBase::getFieldConfiguration	public	function	Gets the field configuration. Overrides DsFieldInterface::getFieldConfiguration
DsFieldBase::getName	public	function	Gets the field name. Overrides DsFieldInterface::getName
DsFieldBase::getTitle	public	function	Returns the title of the field. Overrides DsFieldInterface::getTitle	1
DsFieldBase::isAllowed	public	function	Returns if the field is allowed on the field UI screen. Overrides DsFieldInterface::isAllowed	3
DsFieldBase::isMultiple	public	function	Defines if we are dealing with a multivalue field. Overrides DsFieldInterface::isMultiple	1
DsFieldBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
DsFieldBase::settingsForm	public	function	The form that holds the settings for this plugin. Overrides DsFieldInterface::settingsForm	7
DsFieldBase::settingsSummary	public	function	Returns the summary of the chosen settings. Overrides DsFieldInterface::settingsSummary	7
DsFieldBase::viewMode	public	function	Gets the view mode. Overrides DsFieldInterface::viewMode
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
NodeSubmittedBy::$renderer	protected	property	Drupal core Render service.
NodeSubmittedBy::build	public	function	Renders a field. Overrides Date::build
NodeSubmittedBy::create	public static	function	Creates an instance of the plugin. Overrides Date::create
NodeSubmittedBy::__construct	public	function	Constructs a Display Suite field plugin. Overrides Date::__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.