class FieldItems in Twig Extender 4.x

Twig plugin for loop render children.

Plugin annotation

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

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\twig_extender\Plugin\Twig\TwigPluginBase implements TwigExtensionInterface
      • class \Drupal\twig_extender_extras\Plugin\TwigPlugin\FieldItems

File

modules/twig_extender_extras/src/Plugin/TwigPlugin/FieldItems.php, line 19

Namespace

Drupal\twig_extender_extras\Plugin\TwigPlugin

class FieldItems extends TwigPluginBase {

  /**
   * Identifies the children of an element array, optionally sorted by weight.
   *
   * The children of a element array are those key/value pairs whose key does
   * not start with a '#'. See drupal_render() for details.
   *
   * @param array $elements
   *   The element array whose children are to be identified. Passed by
   *   reference.
   * @param bool $sort
   *   Boolean to indicate whether the children should be sorted by weight.
   *
   * @return array
   *   The filtered array to loop over.
   *
   * @throws \Exception
   */
  public function children(array $elements, $sort = FALSE) {
    if (gettype($elements) !== 'array') {
      throw new \Exception('Could not convert object to array.');
    }
    $ids = Element::children($elements, $sort);
    return array_intersect_key($elements, array_flip($ids));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FieldItems::children	public	function	Identifies the children of an element array, optionally sorted by weight.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	2
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.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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