interface DevelDumperInterface in Devel 8.2

Base interface definition for DevelDumper plugins.

Hierarchy

• interface \Drupal\devel\DevelDumperInterface

See also

\Drupal\devel\Annotation\DevelDumper

\Drupal\devel\DevelDumperPluginManager

\Drupal\devel\DevelDumperBase

Plugin API

File

src/DevelDumperInterface.php, line 13

Namespace

Drupal\devel

interface DevelDumperInterface {

  /**
   * Dumps information about a variable.
   *
   * @param mixed $input
   *   The variable to dump.
   * @param string $name
   *   (optional) The label to output before variable, defaults to NULL.
   */
  public function dump($input, $name = NULL);

  /**
   * Returns a string representation of a variable.
   *
   * @param mixed $input
   *   The variable to export.
   * @param string $name
   *   (optional) The label to output before variable, defaults to NULL.
   *
   * @return string
   *   String representation of a variable.
   */
  public function export($input, $name = NULL);

  /**
   * Returns a string representation of a variable wrapped in a render array.
   *
   * @param mixed $input
   *   The variable to export.
   * @param string $name
   *   (optional) The label to output before variable, defaults to NULL.
   *
   * @return array
   *   String representation of a variable wrapped in a render array.
   */
  public function exportAsRenderable($input, $name = NULL);

  /**
   * Checks if requirements for this plugin are satisfied.
   *
   * @return bool
   *   TRUE is requirements are satisfied, FALSE otherwise.
   */
  public static function checkRequirements();

}

Members

Name	Modifiers	Type	Description	Overrides
DevelDumperInterface::checkRequirements	public static	function	Checks if requirements for this plugin are satisfied.	8
DevelDumperInterface::dump	public	function	Dumps information about a variable.	1
DevelDumperInterface::export	public	function	Returns a string representation of a variable.	8
DevelDumperInterface::exportAsRenderable	public	function	Returns a string representation of a variable wrapped in a render array.	1