You are here

interface DevelDumperInterface in Devel 4.x

Same name and namespace in other branches
  1. 8.3 src/DevelDumperInterface.php \Drupal\devel\DevelDumperInterface
  2. 8 src/DevelDumperInterface.php \Drupal\devel\DevelDumperInterface
  3. 8.2 src/DevelDumperInterface.php \Drupal\devel\DevelDumperInterface

Base interface definition for DevelDumper plugins.

Hierarchy

Expanded class hierarchy of DevelDumperInterface

All classes that implement DevelDumperInterface

See also

\Drupal\devel\Annotation\DevelDumper

\Drupal\devel\DevelDumperPluginManager

\Drupal\devel\DevelDumperBase

Plugin API

File

src/DevelDumperInterface.php, line 13

Namespace

Drupal\devel
View source
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

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