repository·main·Indexed 20 days ago
https://github.com/dflydev/dflydev-dot-access-dataA PHP library for accessing and manipulating deeply nested data structures using dot (a.b.c) or slash (a/b/c) notation. It provides a Data class implementing ArrayAccess for setting, getting, appending, and removing values, as well as importing and exporting associative arrays. Requires PHP 7.1 or higher (version 1.0 for PHP 5.3+).
Dot Access Data allows you to interact with deep, nested data structures using dot notation (e.g., a.b.c) or slash notation (e.g., a/b/c) as path delimiters. It provides a Data class that can be initialized with an existing array and supports setting, getting, appending, and removing values at specific paths.
use Dflydev\
DotAccessData\
Data;
$data = new Data(['a' => ['b' => 'value']]);
echo $data->get('a.b'); // "value"In addition to dot notation, you can use the / character as a path delimiter. The library treats a/b/c identically to a.b.c.
$data->set('a/b/c', 'd');
echo $data->get('a/b/c'); // "d"
// This is equivalent to:
$data->get('a.b.c');To use the current version of Dot Access Data, you must have:
Note: If you are using PHP 5.3+, you should use version 1.0 of this library.
The Data class implements PHP's ArrayAccess interface, allowing you to use standard array syntax for common operations:
$data['key'] calls offsetGet (which uses get())$data['key'] = 'value' calls offsetSet (which uses set())unset($data['key']) calls offsetUnset (which uses remove())isset($data['key']) calls offsetExists (which uses has())$data['user.name'] = 'Alice'; // Uses set()
$val = $data['user.name']; // Uses get()
unset($data['user.name']); // Uses remove()The Data class implements the ArrayAccess interface, allowing you to use standard array syntax for common operations. This is useful for a more native PHP feel when working with the object.
$data['key'] is equivalent to $data->get('key').$data['key'] = 'value' is equivalent to $data->set('key', 'value').isset($data['key']) is equivalent to $data->has('key').unset($data['key']) removes the key.// Get
$data->get('name') === $data['name'];
// Set
$data['name'] = 'Dewey'; // equivalent to $data->set('name', 'Dewey')
// Check
isset($data['name']) === $data->has('name');
// Remove
unset($data['name']);The Data class is the primary entry point. You can use it to manipulate nested structures via dot or slash notation.
set(string $path, $value): Sets a value at the specified path. If the path contains intermediate keys, they are created as nested structures.get(string $path, $default = null): Retrieves the value at the path. If the path does not exist, it returns the $default value. If no default is provided and the path is missing, it throws a MissingPathException.append(string $path, $value): Appends a value to an existing array at the specified path.has(string $path): Returns true if the path exists, false otherwise.remove(string $path): Removes the data at the specified path.getData(string $path): Returns a new DataInterface instance representing the sub-structure at the given path.use Dflydev\DotAccessData\Data;
$data = new Data;
$data->set('a.b.c', 'C');
$data->append('a.b.d', 'D1');
$data->set('a.b.e', ['E0', 'E1', 'E2']);
// Accessing values
$val = $data->get('a.b.c'); // 'C'
$exists = $data->has('a.b.c'); // true
// Using defaults for missing paths
$missing = $data->get('non.existent', 'default_value'); // 'default_value'Use export(): array to retrieve the underlying raw associative array from the Data instance.
$rawArray = $data->export();Use has(string $key): bool to verify if a specific path exists within the data structure without retrieving the value.
if ($data->has('user.profile')) {
// Path exists
}Use set(string $key, $value = null) to assign a value to a specific path. If the intermediate keys in the path do not exist, they will be created as arrays. If an intermediate key exists but is not an array, a DataException is thrown.
$data->set('settings.theme.color', 'blue');Use append(string $key, $value = null) to add a value to a list at a specific path. If the key does not exist or is not an array, append will promote the value to an array to accommodate the new entry.
$data->append('logs.errors', 'Connection timeout');
// If 'logs.errors' didn't exist, it is now ['Connection timeout']Use remove(string $key): void to delete a value at a specific path. If the path does not exist, the method returns silently without throwing an exception.
$data->remove('user.profile.name');You can merge new data into the existing structure using:
import(array $data, int $mode = self::REPLACE): Merges a plain associative array.importData(DataInterface $data, int $mode = self::REPLACE): Merges another DataInterface instance.$data->import(['new_key' => 'new_value']);