You are here

class MomentFormat in Twig Extender 8.2

Same name and namespace in other branches
  1. 8.4 modules/twig_extender_extras/src/Plugin/TwigPlugin/MomentFormat.php \Drupal\twig_extender_extras\Plugin\TwigPlugin\MomentFormat
  2. 8.3 modules/twig_extender_extras/src/Plugin/TwigPlugin/MomentFormat.php \Drupal\twig_extender_extras\Plugin\TwigPlugin\MomentFormat
  3. 4.x modules/twig_extender_extras/src/Plugin/TwigPlugin/MomentFormat.php \Drupal\twig_extender_extras\Plugin\TwigPlugin\MomentFormat

Provide helper methods for Drupal render elements.

Plugin annotation


@TwigPlugin(
  id = "twig_extender_moment_format",
  label = @Translation("Identifies the children of an element array, optionally sorted by weight."),
  type = "filter",
  name = "moment_format",
  function = "moment"
)

Hierarchy

Expanded class hierarchy of MomentFormat

File

modules/twig_extender_extras/src/Plugin/TwigPlugin/MomentFormat.php, line 18

Namespace

Drupal\twig_extender_extras\Plugin\TwigPlugin
View source
class MomentFormat extends BaseMoment {

  /**
   * Format a date with moment php.
   *
   * @param mixed $date
   *   The element array whose children are to be identified. Passed by
   *   reference.
   * @param string $format
   *   Boolean to indicate whether the children should be sorted by weight.
   * @param mixed $timezone
   *   Boolean to indicate whether the children should be sorted by weight.
   * @param mixed $js
   *   Boolean to indicate whether the children should be sorted by weight.
   *
   * @return array
   *   Array for render.
   *
   * @throws \Exception
   */
  public function moment($date, $format, $timezone = NULL, $js = FALSE) {
    $moment = $this
      ->getMoment($date, $timezone);
    $value = $moment
      ->format($format);
    if ($js === TRUE) {
      $value = $moment
        ->format($format, new MomentJs());
    }
    $build = [
      '#cache' => [
        'contexts' => [
          'languages',
          'timezone',
        ],
      ],
      '#markup' => $value,
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BaseMoment::getDefaultTimezone protected function Get default drupal timezone.
BaseMoment::getLocale protected function Get current language.
BaseMoment::getMoment protected function Get moment library.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MomentFormat::moment public function Format a date with moment php.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.
TwigPluginBase::getFunction public function Get type of the twig extension. Overrides TwigExtensionInterface::getFunction
TwigPluginBase::getName public function Get type of the twig extension. Overrides TwigExtensionInterface::getName
TwigPluginBase::getType public function Get type of the twig extension. Overrides TwigExtensionInterface::getType
TwigPluginBase::register public function Get type of the twig extension. Overrides TwigExtensionInterface::register