W3cubDocs

/Drupal 8

public function ConfigBase::get

public ConfigBase::get($key = '')

Gets data from this configuration object.

Parameters

string $key: A string that maps to a key within the configuration data. For instance in the following configuration array:

  array(
    'foo' => array(
      'bar' => 'baz',
    ),
  );
  

A key of 'foo.bar' would return the string 'baz'. However, a key of 'foo' would return array('bar' => 'baz'). If no key is specified, then the entire data array is returned.

Return value

mixed The data that was requested.

File

core/lib/Drupal/Core/Config/ConfigBase.php, line 131

Class

ConfigBase
Provides a base class for configuration objects with get/set support.

Namespace

Drupal\Core\Config

Code

public function get($key = '') {
  if (empty($key)) {
    return $this->data;
  }
  else {
    $parts = explode('.', $key);
    if (count($parts) == 1) {
      return isset($this->data[$key]) ? $this->data[$key] : NULL;
    }
    else {
      $value = NestedArray::getValue($this->data, $parts, $key_exists);
      return $key_exists ? $value : NULL;
    }
  }
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Config!ConfigBase.php/function/ConfigBase::get/8.1.x