PHP Класс JBZoo\Data\Data

Наследование: extends ArrayObject
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( array | string $data = [] ) Class constructor
__toString ( ) : string Magic method to convert the data to a string Returns a serialized version of the data contained in the data object using serialize()
find ( string $key, mixed $default = null, mixed $filter = null, string $separator = '.' ) : mixed Find a key in the data recursively This method finds the given key, searching also in any array or object that's nested under the current data object.
flattenRecursive ( ) : array Return flattened array copy. Keys are NOT preserved.
get ( string $key, mixed $default = null, mixed $filter = null ) : mixed Get a value from the data given its key
has ( string $name ) : boolean Checks if the given key is present
is ( string $key, mixed $compareWith = true, boolean $strictMode = false ) : boolean Compare value by key with somethig
offsetGet ( $index )
remove ( string $name ) Remove a value from the data
search ( mixed $needle ) : string | false Find a value also in nested arrays/objects
set ( string $name, mixed $value ) Set a value in the data
write ( ) : string Encode an array or an object in INI format

Защищенные методы

Метод Описание
_decode ( string $string ) : mixed Utility Method to unserialize the given data
_encode ( mixed $data ) : string Utility Method to serialize the given data
_filter ( mixed $value, mixed $filter ) : mixed Filter value before return
_isMulti ( $array ) : boolean Check is array is nested
_readFile ( string $filePath ) : null | string

Описание методов

__construct() публичный Метод

Class constructor
public __construct ( array | string $data = [] )
$data array | string The data array

__toString() публичный Метод

Magic method to convert the data to a string Returns a serialized version of the data contained in the data object using serialize()
public __toString ( ) : string
Результат string

_decode() защищенный Метод

Utility Method to unserialize the given data
protected _decode ( string $string ) : mixed
$string string
Результат mixed

_encode() защищенный Метод

Utility Method to serialize the given data
protected _encode ( mixed $data ) : string
$data mixed The data to serialize
Результат string The serialized data

_filter() защищенный Метод

Filter value before return
protected _filter ( mixed $value, mixed $filter ) : mixed
$value mixed
$filter mixed
Результат mixed

_isMulti() защищенный Метод

Check is array is nested
protected _isMulti ( $array ) : boolean
$array
Результат boolean

_readFile() защищенный Метод

protected _readFile ( string $filePath ) : null | string
$filePath string
Результат null | string

find() публичный Метод

Example: $data->find('parentkey.subkey.subsubkey');
public find ( string $key, mixed $default = null, mixed $filter = null, string $separator = '.' ) : mixed
$key string The key to search for. Can be composed using $separator as the key/subkey separator
$default mixed The default value
$filter mixed Filter returned value
$separator string The separator to use when searching for subkeys. Default is '.'
Результат mixed

flattenRecursive() публичный Метод

Return flattened array copy. Keys are NOT preserved.
public flattenRecursive ( ) : array
Результат array

get() публичный Метод

Get a value from the data given its key
public get ( string $key, mixed $default = null, mixed $filter = null ) : mixed
$key string The key used to fetch the data
$default mixed The default value
$filter mixed Filter returned value
Результат mixed

has() публичный Метод

Checks if the given key is present
public has ( string $name ) : boolean
$name string The key to check
Результат boolean

is() публичный Метод

Compare value by key with somethig
public is ( string $key, mixed $compareWith = true, boolean $strictMode = false ) : boolean
$key string
$compareWith mixed
$strictMode boolean
Результат boolean

offsetGet() публичный Метод

public offsetGet ( $index )

remove() публичный Метод

Remove a value from the data
public remove ( string $name )
$name string The key of the data to remove

set() публичный Метод

Set a value in the data
public set ( string $name, mixed $value )
$name string The key used to set the value
$value mixed The value to set

write() публичный Метод

Encode an array or an object in INI format
public write ( ) : string
Результат string