interface SchemaMetatagManagerInterface in Schema.org Metatag 8.2

The Schema Metatag Manager.

@package Drupal\schema_metatag

Hierarchy

• interface \Drupal\schema_metatag\SchemaMetatagManagerInterface

1 file declares its use of SchemaMetatagManagerInterface

PropertyTypeBase.php in src/Plugin/schema_metatag/PropertyTypeBase.php

File

src/SchemaMetatagManagerInterface.php, line 10

Namespace

Drupal\schema_metatag

interface SchemaMetatagManagerInterface {

  /**
   * Parse tags added by Schema Metatag into JsonLD array.
   *
   * @param array $elements
   *   Array of Metatag values, as formatted for the head of a page.
   *
   * @return array
   *   Array of Schema metatag tags, ready to be turned into JSON LD.
   */
  public static function parseJsonld(array &$elements);

  /**
   * Convert a metatags-style data array to JSON LD.
   *
   * @param array $items
   *   Array of Schema metatag tags, ready to be turned into JSON LD.
   *
   * @return string
   *   Json-encoded representation of the structured data.
   */
  public static function encodeJsonld(array $items);

  /**
   * Create the JSON LD render array.
   *
   * @param string $jsonld
   *   The JSONLD string value.
   *
   * @return array
   *   A render array for the JSONLD, .
   */
  public static function renderArrayJsonLd($jsonld);

  /**
   * Render JSON LD for a specific entity.
   *
   * Useful to pass to a decoupled front end, for instance.
   *
   * @param string $entity
   *   The entity that contains JSONLD.
   * @param string $entity_type
   *   The type of entity.
   *
   * @return string
   *   The JSONLD markup.
   */
  public static function getRenderedJsonld($entity = NULL, $entity_type = NULL);

  /**
   * Pivot multiple value results.
   *
   * Complex serialized value that might contain multiple
   * values. In this case we have to pivot the results.
   *
   * @param mixed $content
   *   The value to pivot.
   *
   * @return array
   *   The pivoted array.
   */
  public static function pivot($content);

  /**
   * If the item is an array with numeric keys, count the keys.
   *
   * @param mixed $item
   *   The value to assess.
   *
   * @return int
   *   The number of numeric keys in the array.
   */
  public static function countNumericKeys($item);

  /**
   * Explode values if this is a multiple value field.
   *
   * @param string $value
   *   The value to explode.
   *
   * @return array
   *   The array of values.
   */
  public static function explode($value);

  /**
   * Wrapper for serialize to prevent errors.
   *
   * @param mixed $value
   *   The values to serialize.
   *
   * @return string
   *   The serialized value.
   */
  public static function serialize($value);

  /**
   * Wrapper for unserialize to prevent errors.
   *
   * @param string $value
   *   The value to unserialize.
   *
   * @return array
   *   The unserialized array.
   */
  public static function unserialize($value);

  /**
   * Check if a value looks like a serialized array.
   *
   * @param string $value
   *   The string value to assess.
   *
   * @return bool
   *   TRUE/FALSE.
   */
  public static function isSerialized($value);

  /**
   * Remove empty values from a nested array.
   *
   * If the result is an empty array, the nested array is completely empty.
   *
   * @param mixed $array
   *   The array or object to assess.
   *
   * @return array
   *   The original array with empty values removed.
   */
  public static function arrayTrim($array);

  /**
   * Is object?
   *
   * Whether this array represents an object.
   *
   * See if the array has numeric keys (it's actually an array) or not (it's
   * an object that should have a @type or @id).
   *
   * @param mixed $array
   *   The value to assess.
   *
   * @return bool
   *   TRUE/FALSE.
   */
  public static function isObject($array);

  /**
   * Update serialized item length computations.
   *
   * Prevent unserialization error if token replacements are different lengths
   * than the original tokens.
   *
   * @param string $value
   *   The string serialization value to recompute.
   *
   * @return string
   *   The recomputed serialized value.
   */
  public static function recomputeSerializedLength($value);

  /**
   * Generates a pseudo-random string of ASCII characters of codes 32 to 126.
   *
   * @param int $length
   *   Length of random string to generate.
   *
   * @return string
   *   Pseudo-randomly generated unique string including special characters.
   */
  public static function randomString($length = 8);

  /**
   * Generates a unique random string containing letters and numbers.
   *
   * @param int $length
   *   Length of random string to generate.
   *
   * @return string
   *   Randomly generated unique string.
   */
  public static function randomMachineName($length = 8);

  /**
   * Default values for input into nested elements.
   *
   * @return array
   *   An array of default values.
   *   - @var string 'title'
   *       The title to use for the form element.
   *   - @var string 'description'
   *       The description to use for the form element.
   *   - @var array 'value'
   *       The current value of the form element.
   *   - @var string 'visibility_selector'
   *       The selector to use in assessing form element visibility, usually
   *       the @type element.
   *   - @var array 'tree_parent'
   *       The top level to use for @type, defaults to ''.
   *   - @var int 'tree_depth'
   *       The depth to go in the tree hierarchy, defaults to -1.
   *   - @var string 'type'
   *       The form element type, defaults to 'textfield'.
   *   - @var string 'multiple'
   *       Whether multiple values should be allowed, defaults to FALSE.
   */
  public static function defaultInputValues();

  /**
   * Alternate visibility selector for the field element.
   *
   * This is necessary because the form elements on the general configuration
   * form have different parents than the form elements in the metatags field
   * widget. This function makes is possible to convert the #states visibility
   * selectors for the general configuration form into the right pattern
   * so they will work on the field widget.
   *
   * @param string $selector
   *   The selector constructed for the main metatag form.
   *
   * @return string
   *   A rewritten selector that will work in the field form.
   */
  public static function altSelector($selector);

}

Members

Name	Modifiers	Type	Description	Overrides
SchemaMetatagManagerInterface::altSelector	public static	function	Alternate visibility selector for the field element.	1
SchemaMetatagManagerInterface::arrayTrim	public static	function	Remove empty values from a nested array.	1
SchemaMetatagManagerInterface::countNumericKeys	public static	function	If the item is an array with numeric keys, count the keys.	1
SchemaMetatagManagerInterface::defaultInputValues	public static	function	Default values for input into nested elements.	1
SchemaMetatagManagerInterface::encodeJsonld	public static	function	Convert a metatags-style data array to JSON LD.	1
SchemaMetatagManagerInterface::explode	public static	function	Explode values if this is a multiple value field.	1
SchemaMetatagManagerInterface::getRenderedJsonld	public static	function	Render JSON LD for a specific entity.	1
SchemaMetatagManagerInterface::isObject	public static	function	Is object?	1
SchemaMetatagManagerInterface::isSerialized	public static	function	Check if a value looks like a serialized array.	1
SchemaMetatagManagerInterface::parseJsonld	public static	function	Parse tags added by Schema Metatag into JsonLD array.	1
SchemaMetatagManagerInterface::pivot	public static	function	Pivot multiple value results.	1
SchemaMetatagManagerInterface::randomMachineName	public static	function	Generates a unique random string containing letters and numbers.	1
SchemaMetatagManagerInterface::randomString	public static	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.	1
SchemaMetatagManagerInterface::recomputeSerializedLength	public static	function	Update serialized item length computations.	1
SchemaMetatagManagerInterface::renderArrayJsonLd	public static	function	Create the JSON LD render array.	1
SchemaMetatagManagerInterface::serialize	public static	function	Wrapper for serialize to prevent errors.	1
SchemaMetatagManagerInterface::unserialize	public static	function	Wrapper for unserialize to prevent errors.	1