Phalcon\Registry is an object oriented array. It extends Phalcon\Collection but cannot be extended itself since all of its methods are declared final. It offers speed, as well as implementations of various PHP interfaces. These are:
English (US)
Czech
German
Greek
Persian
French
Indonesian
Italian
Korean
Japanese
Mongolian
Dutch
Polish
Portuguese, Brazilian
Russian
Serbian (Cyrillic)
Thai
Turkish
Ukrainian
Chinese Simplified<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
Puede construir el objeto como cualquier otro objeto en PHP. Sin embargo, el constructor acepta un parámetro opcional array, que rellenará el objeto por usted.
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
También puede reutilizar el componente, volviéndolo a rellenar. Phalcon\Registry exposes the clear() and init() methods, which will clear and repopulate the internal array respectively,
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->count(); // 2
$data = [
'year' => 1776,
];
$collection->clear();
$collection->init($data);
echo $collection->count(); // 1
As mentioned above, Phalcon\Registry implements several interfaces, in order to make the component as flexible as possible. Retrieving data stored in an element can be done by using:
__get()$collection[$element])offsetGet()get()The fastest way is by using the property syntax:
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->year; // 1776
You can use __get($element) but it is not advisable as it is much slower than the property syntax. The same applies to offsetGet
echo $collection->__get('year'); // 1776
echo $collection['year']; // 1776
echo $collection->offsetGet('year'); // 1776
echo $collection->get('year', 1776, true); // 1776
public function get(
string $element,
mixed $defaultValue = null,
string $cast = null
): mixed
Using get() offers three extra parameters. When $defaultValue is defined in the call and the element is not found, $defaultValue will be returned. The cast parameter accepts a string that defines what the returned value will be casted. The available values are:
arrayboolbooleandoublefloatintintegernullobjectstringTo check whether an element exists or not in the collection, you can use the following:
isset() on the property__isset()isset($collection[$element]))offsetExists()has()The fastest way is by using the property syntax:
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo isset($collection->year); // true
You can use __isset(element) but it is not advisable as it is much slower than the property syntax. The same applies to offsetExists
echo $collection->__isset('year'); // true
echo isset($collection['year']); // true
echo $collection->offsetExists('year'); // true
echo $collection->has('year', true); // true
public function has(string $element): bool
To set an element in the collection, you can use the following:
__set()offsetSet()set()The fastest way is by using the property syntax:
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
];
$collection = new Registry($data);
$collection->year = 1776;
You can use __set($element, $value) but it is not advisable as it is much slower than the property syntax. The same applies to offsetSet
$collection->__set('year', 1776);
$collection['year'] = 1776;
$collection->offsetSet('year', 1776);
$collection->set('year', 1776);
To remove an element in the collection, you can use the following:
__unset()offsetUnset()remove()The fastest way is by using the property syntax:
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
];
$collection = new Registry($data);
unset($collection->year);
You can use __unset($element) but it is not advisable as it is much slower than the property syntax. The same applies to offsetUnset
$collection->__unset('year');
unset($collection['year']);
$collection->offsetUnset('year');
$collection->remove('year');
public function remove(string $element): void
Dado que el objeto de colección implementa \IteratorAggregate, puedes iterar con facilidad a través del objeto. El método getIterator() devuelve un objeto ArrayIterator()
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
foreach ($collection as $key => $value) {
echo $key . ' - ' . $value . PHP_EOL;
}
La implementación de la interfaz \Countable expone el método count(), que almacena el número de elementos en la colección.
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->count(); // 2
The \Serializable and \JsonSerializable interfaces expose methods that allow you to serialize and unserialize the object. serialize() and unserialize() use PHP’s serialize and unserialize functions. jsonSerialize() returns an array which can be used with json_encode to serialize the object.
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->serialize(); // a:2:{s:6:"colors";a:3:{i:0;s:3:"red";i:1;s:5:"white";i:2;s:4:"blue";}s:4:"year";i:1776;}
$serialized = 'a:2:{s:6:"colors";a:3:{i:0;s:3:"red";i:1;s:5:"white";i:2;s:4:"blue";}s:4:"year";i:1776;}';
$collection->unserialize($serialized);
echo $collection->jsonSerialize(); // $data
Phalcon\Registry also exposes two transformation methods: toArray() and toJson(int $options). toArray() returns the object transformed as an array. This method returns the same array as jsonSerialize().
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->toArray(); // $data
toJson(int $options) returns a JSON representation of the object. It uses json_encode internally and accepts a parameter, which represents the flags that json_encode accepts. By default the options are set up with the value 74, (RFC4327) which translates to:
JSON_HEX_TAGJSON_HEX_APOSJSON_HEX_AMPJSON_HEX_QUOTJSON_UNESCAPED_SLASHESYou can pass any valid flags to the method according to your needs.
<?php
use Phalcon\Registry;
$data = [
'colors' => [
'red',
'white',
'blue',
],
'year' => 1776,
];
$collection = new Registry($data);
echo $collection->toJson(); // ["red","white","blue"],"year":1776}
echo $collection->toJson(74 + JSON_PRETTY_PRINT);
/**
{
"colors": [
"red",
"white",
"blue"
],
"year": 1776
}
*/