get_class_vars - PHP code example

Introspection in PHP - Get_Class_Vars() and Get_Method_Vars()

In PHP you can perform introspection on objects and classes, which allows you to discover information about the class at runtime. This is useful for things like writing generic debuggers and state savers (like serialize()).

One of the most useful functions is get_class_vars(), which returns an associative array of the default properties for a given class. It accepts a single argument, which is the name of the class to inspect.

This function is similar to get_method_vars(), which returns the names of all methods defined for a particular class. However, get_class_vars() only reports the names of variables that are public, whereas get_method_vars() also reports the default values for those variables.

Both get_class_vars() and get_method_vars() return an associative array of keys and values, with the key being the variable name and the value being its default value. In addition, both of these functions allow you to pass in a parameter, which can be either the object itself or the class name.

Unlike get_class_vars(), get_method_vars() can be called with a NULL value for the object, but as of PHP 4.2.0 NULL will no longer raise an error when used in this manner. However, you should note that getting a NULL value from the class object will not expose any private or protected properties. This is because of the way that static binding in PHP works, and how __CLASS__ works with inherited classes. This is an improvement over previous versions of PHP, where the private and protected properties were prefixed with nul bytes.

get_class_vars example

foreach ($options as $name => $value) {
            $this->$name = $value;
        }
    }

    protected function normalizeOptions(mixed $options): array
    {
        $normalizedOptions = [];
        $defaultOption = $this->getDefaultOption();
        $invalidOptions = [];
        $missingOptions = array_flip((array) $this->getRequiredOptions());
        $knownOptions = get_class_vars(static::class);

        if (\is_array($options) && isset($options['value']) && !property_exists($this, 'value')) {
            if (null === $defaultOption) {
                throw new ConstraintDefinitionException(sprintf('No default option is configured for constraint "%s".', static::class));
            }

            $options[$defaultOption] = $options['value'];
            unset($options['value']);
        }

        if (\is_array($options)) {

private static array $defaultProperties = [];

    /** * @internal */
    public function __sleep(): array
    {
        $properties = [];

        if (!isset(self::$defaultProperties[$c = static::class])) {
            self::$defaultProperties[$c] = get_class_vars($c);

            foreach ((new \ReflectionClass($c))->getStaticProperties() as $k => $v) {
                unset(self::$defaultProperties[$c][$k]);
            }
        }

        foreach (self::$defaultProperties[$c] as $k => $v) {
            if ($this->$k !== $v) {
                $properties[] = $k;
            }
        }

$this->assertEquals($expected_derived_plugin_definitions, $actual_definitions);
  }

  /** * Data provider. * * @return \Generator * Test scenarios. */
  public function providerTestDerivedPluginDefinitions(): \Generator {
    // Defaults inherited from CKEditor5AspectsOfCKEditor5Plugin.     $ckeditor5_aspects_defaults = get_class_vars(CKEditor5AspectsOfCKEditor5Plugin::class);
    // Defaults inherited from DrupalAspectsOfCKEditor5Plugin.     $drupal_aspects_defaults = get_class_vars(DrupalAspectsOfCKEditor5Plugin::class);

    $simple_deriver_additional_files = [
      'src' => [
        'Plugin' => [
          'CKEditor5Plugin' => [
            'SimpleDeriver.php' => <<<'PHP' <?php namespace Drupal\ckeditor5_derived_plugin\Plugin\CKEditor5Plugin; use Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition; use Drupal\Component\Plugin\Derivative\DeriverBase; class SimpleDeriver extends DeriverBase { public function getDerivativeDefinitions($base_plugin_definition) { assert($base_plugin_definition instanceof CKEditor5PluginDefinition); foreach (['bar', 'baz'] as $id) { $definition = $base_plugin_definition->toArray(); $definition['id'] = $id; $definition['drupal']['label'] = sprintf("Foo %s", $id); $this->derivatives[$id] = new CKEditor5PluginDefinition($definition); } return $this->derivatives; } }

/** * Outputs the object data as array. * Used to convert a form structure to * a uniform array structure which can be used * from the Shopware\Components\Form\Persister and * Shopware\Components\Form\Hydrator * * @return array */
    public function toArray()
    {
        $properties = get_class_vars(\get_class($this));

        $data = [
            'type' => \get_class($this),
        ];

        foreach ($properties as $property => $value) {
            $method = 'get' . ucfirst($property);

            if (!method_exists($this, $method)) {
                continue;
            }

    public function initialize($config)
    {
        $this->clear();

        if ($config instanceof \Config\Email) {
            $config = get_object_vars($config);
        }

        foreach (array_keys(get_class_vars(static::class)) as $key) {
            if (property_exists($this, $key) && isset($config[$key])) {
                $method = 'set' . ucfirst($key);

                if (method_exists($this, $method)) {
                    $this->{$method}($config[$key]);
                } else {
                    $this->{$key} = $config[$key];
                }
            }
        }