You are here

class PhpArrayDumper in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Component/DependencyInjection/Dumper/PhpArrayDumper.php \Drupal\Component\DependencyInjection\Dumper\PhpArrayDumper
  2. 10 core/lib/Drupal/Component/DependencyInjection/Dumper/PhpArrayDumper.php \Drupal\Component\DependencyInjection\Dumper\PhpArrayDumper

PhpArrayDumper dumps a service container as a PHP array.

The format of this dumper is a human-readable serialized PHP array, which is very similar to the YAML based format, but based on PHP arrays instead of YAML strings.

It is human-readable, for a machine-optimized version based on this one see \Drupal\Component\DependencyInjection\Dumper\OptimizedPhpArrayDumper.

Hierarchy

  • class \Drupal\Component\DependencyInjection\Dumper\OptimizedPhpArrayDumper extends \Symfony\Component\DependencyInjection\Dumper\Dumper

Expanded class hierarchy of PhpArrayDumper

See also

\Drupal\Component\DependencyInjection\PhpArrayContainer

File

core/lib/Drupal/Component/DependencyInjection/Dumper/PhpArrayDumper.php, line 19

Namespace

Drupal\Component\DependencyInjection\Dumper
View source
class PhpArrayDumper extends OptimizedPhpArrayDumper {

  /**
   * {@inheritdoc}
   */
  public function getArray() {
    $this->serialize = FALSE;
    return parent::getArray();
  }

  /**
   * {@inheritdoc}
   */
  protected function dumpCollection($collection, &$resolve = FALSE) {
    $code = [];
    foreach ($collection as $key => $value) {
      if (is_array($value)) {
        $code[$key] = $this
          ->dumpCollection($value);
      }
      else {
        $code[$key] = $this
          ->dumpValue($value);
      }
    }
    return $code;
  }

  /**
   * {@inheritdoc}
   */
  protected function getServiceCall($id, $invalid_behavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE) {
    if ($invalid_behavior !== ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE) {
      return '@?' . $id;
    }
    return '@' . $id;
  }

  /**
   * {@inheritdoc}
   */
  protected function getParameterCall($name) {
    return '%' . $name . '%';
  }

  /**
   * {@inheritdoc}
   */
  protected function supportsMachineFormat() {
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
OptimizedPhpArrayDumper::$aliases protected property A list of container aliases.
OptimizedPhpArrayDumper::$serialize protected property Whether to serialize service definitions or not.
OptimizedPhpArrayDumper::dump public function
OptimizedPhpArrayDumper::dumpCallable protected function Dumps callable to a PHP array.
OptimizedPhpArrayDumper::dumpMethodCalls protected function Dumps method calls to a PHP array.
OptimizedPhpArrayDumper::dumpValue protected function Dumps the value to PHP array format.
OptimizedPhpArrayDumper::escape protected function Escapes parameters.
OptimizedPhpArrayDumper::getAliases protected function Gets the aliases as a PHP array.
OptimizedPhpArrayDumper::getParameters protected function Gets parameters of the container as a PHP array.
OptimizedPhpArrayDumper::getPrivateServiceCall protected function Gets a private service definition in a suitable format.
OptimizedPhpArrayDumper::getReferenceCall protected function Gets a service reference for a reference in a suitable PHP array format.
OptimizedPhpArrayDumper::getServiceDefinition protected function Gets a service definition as PHP array.
OptimizedPhpArrayDumper::getServiceDefinitions protected function Gets services of the container as a PHP array.
OptimizedPhpArrayDumper::prepareParameters protected function Prepares parameters for the PHP array dumping.
PhpArrayDumper::dumpCollection protected function Dumps a collection to a PHP array. Overrides OptimizedPhpArrayDumper::dumpCollection
PhpArrayDumper::getArray public function Gets the service container definition as a PHP array. Overrides OptimizedPhpArrayDumper::getArray
PhpArrayDumper::getParameterCall protected function Gets a parameter reference in a suitable PHP array format. Overrides OptimizedPhpArrayDumper::getParameterCall
PhpArrayDumper::getServiceCall protected function Gets a service reference for an ID in a suitable PHP array format. Overrides OptimizedPhpArrayDumper::getServiceCall
PhpArrayDumper::supportsMachineFormat protected function Whether this supports the machine-optimized format or not. Overrides OptimizedPhpArrayDumper::supportsMachineFormat