array object php скачать - array object php -код скачать

Устарел

Эта библиотека не в активной разработке. Различные другие библиотеки сбора предоставляют наибольшую функциональность, которая нам нужна из коробки.

Только исправления ошибок.

Массив объект

ArrayObject-это библиотека PHP, которая обеспечивает легкий интерфейс для свободной работы с массивами.

ArrayObject предоставляет обертку вокруг встроенного типа array PHP, который включает в себя методы фильтрации и получение предметов, и удобно рассматривает отдельные элементы и коллекции как с тем же объектом.

Это особенно полезно для работы с ответами JSON по запросам API.

Эта библиотека используется клиентом Hyper HTTP для извлечения данных из ответов супер интуитивно понятным.

Установка

composer require rexlabs/array-object

Использование

 <?php
require ' vendor/autoload.php ' ;
use Rexlabs  ArrayObject  ArrayObject ;

// Initialise from an Array
$ obj = ArrayObject:: fromArray ([...]);

// Initialise from a JSON encoded string
$ obj = ArrayObject:: fromJson ( $ str );

// Output to array
$ arr = $ obj -> toArray ();

// Output to JSON encoded string
$ json = $ obj -> toJson ();

Примеры ниже основаны на следующих входных данных.

{
  "books" : [
    {
      "id" : 1 ,
      "title" : " 1984 " ,
      "author" : " George Orwell "
    },
    {
      "id" : 2 ,
      "title" : " Pride and Prejudice " ,
      "author" : " Jane Austen "
    }
  ]
}

Основы

 $ obj -> books ; // Instance of ArrayObject
$ obj -> books -> pluckArray ( ' author ' ); // array [ 'George Orwell', 'Jane Austen' ]
$ obj -> pluckArray ( ' books.author ' ); // array [ 'George Orwell', 'Jane Austen' ]
$ obj -> books -> count (); // 2
$ obj -> books -> isCollection (); // true
$ obj -> books [ 0 ]; // Instance of ArrayObject
$ obj -> books [ 0 ]-> isCollection (); // false
$ obj -> books [ 0 ]-> id ; // 1

Примечание. Все методы изящно обрабатывают отдельный элемент как массив.

получить ($ key, $ default = null)

Метод get() позволяет получить значение свойства и получать по умолчанию, если значение не существует. Он также поддерживает глубину, которая обозначена с . :

 $ obj -> get ( ' books.0 ' );       // ArrayObject
$ obj -> get ( ' books.0.title ' ); // "1984"
$ obj -> get ( ' books.1.title ' ); // "Pride and Prejudice"
$ obj -> get ( ' books.0.missing ' , ' Default value ' ); // "Default value"

Вы также можете получить свойства, используя синтаксис свойств объекта (мы перегружаем __get() для достижения этого):

 $ obj -> books [ 0 ];           // ArrayObject
$ obj -> books [ 0 ]-> title ;    // "1984"
$ obj -> books [ 1 ]-> title ;    // "Pride and Prejudice"
$ obj -> books [ 0 ]-> missing ;  // throws InvalidPropertyException

getRaw ($ key, $ default = null)

Когда значение, извлеченное через get('some.key') является массивом, оно влечет за собой в экземпляр ArrayObject . Метод getRaw() , однако, не выполняет никаких «бокса» на возвращенном значении.

 $ obj -> get ( ' books ' );            // ArrayObject
$ obj -> getRaw ( ' books ' );         // (array)
$ obj -> get ( ' books.0.title ' );    // "1984"
$ obj -> getRaw ( ' books.0.title ' ); // "1984"

SET ($ key, $ value, $ anyifexists = false)

Метод set() позволяет установить свойство, используя точечную нотацию. Он автоматически создаст основную структуру массива:

 $ obj -> set ( ' some.deep.key ' , $ value );  // Set nested property
$ obj -> set ( ' some_key ' , $ anotherArrayObject );  // Pass an ArrayObjectInterface as value

Когда флаг $onlyIfExists будет передаваться как true , он установит это свойство только в том случае, если ключ уже существует.

getorfail ($ key)

Подобно get() , но бросит InvalidPropertyException , когда ключ не найден.

есть ($ key)

Чтобы проверить наличие элемента, используйте метод has() :

 $ obj -> has ( ' books ' ); // true
$ obj -> has ( ' books.0.id ' ); // true
$ obj -> has ( ' books.1.name ' ); // false
$ obj -> has ( ' books.5 ' ); // false

каждый (обратный вызов)

Цикл сбора может быть достигнута, передавая обратный вызов each() :

 $ obj -> books -> each ( function ( $ book ) {
    echo " ID: { $ book -> id } , title: { $ book -> title }n" ;
});

foreach ( $ obj -> books as $ book ) {
    echo " ID: { $ book -> id } , title: { $ book -> title }n" ;
}

Если у вас есть один предмет, он все еще работает.

итератор

Поскольку ArrayObject реализует интерфейс итератора, вы можете просто foreach() над объектом. Это работает для отдельных элементов или коллекций.

 foreach ( $ obj -> books as $ book ) {
    echo " ID: { $ book -> id } , title: { $ book -> title }n" ;
}

Оснуть ($ key)

Возвращает новую коллекцию, в которой содержится осадка.

 $ titles = $ obj -> books -> pluck ( ' title ' );  // ArrayObject
$ arr = $ titles -> toArray ();  // ['1984', 'Pride and Prejudice']

Pluckarray ($ Key)

Возвращает новое массив осажденной собственности. Это обеспечивает ярлык от pluck($key)->toArray() :

 $ arr = $ obj -> books -> pluckArray ( ' title ' );  // ['1984', 'Pride and Prejudice']

считать()

Вы можете вызовать счет от любого узла:

 $ obj -> count (); // 1
$ obj -> books -> count (); // 2
$ obj -> books [ 0 ]-> count (); // 1

Примечание. При вызове на один элемент (т.е. не коллекция), он вернется 1.

hasitems ()

Возвращает True, когда коллекция содержит хотя бы один элемент.

 $ obj -> hasItems ();

Примечание. При вызове на один элемент (т.е. не коллекция), он вернет True

Фильтр (обратный вызов | Array $ Filter)

Примените либо обратный вызов, либо массив «где» условия, и возвращайте только элементы, которые соответствуют.

Используя обратный вызов, каждый элемент является экземпляром ArrayObject:

 // Only return items with a title
$ filteredBooksWithTitle = $ obj -> books -> filter ( function ( $ book ) {
  return $ book -> has ( ' title ' );
});

Вы также можете указать список условий, используя массив:

 // Only return items with a title
$ filteredBooksWithTitle = $ obj -> books -> filter ([ " title " => ' 1984 ' ]);

toarray ()

Получение оригинального массива доступно с помощью метода toArray() :

 $ obj -> books [ 0 ]-> toArray (); // [ 'id' => 1, 'title' => '1984', 'author' => 'George Orwell' ]
$ obj -> get ( 1 )-> toArray (); // [ 'id' => 2, 'title' => 'Pride and Prejudice', 'author' => 'Jane Austen' ]
$ obj -> books -> toArray (); // [ [ 'id' => 1, 'title' => '1984', 'author' => 'George Orwell' ], [ 'id' => 2, 'title' => 'Pride and Prejudice', 'author' => 'Jane Austen' ] ]
$ obj -> toArray (); // [ 'books' => [ [ 'id' => 1, 'title' => '1984', 'author' => 'George Orwell' ], [ 'id' => 2, 'title' => 'Pride and Prejudice', 'author' => 'Jane Austen' ] ] ]

tojson ()

Возвращает кодируемую строку JSON из базового массива:

 $ json = $ obj -> toJson (); // '{ "some_prop": [ "val1", "val2" ] }`

isCollection ()

Определяет, является ли основной массив коллекцией.

 $ obj -> books -> isCollection (); // true
$ obj -> get ( ' books.0 ' )-> isCollection (); // false
$ obj -> isCollection (); // false

без устранения ($ val [, $ val ...])

Добавляет один или несколько элементов в начало коллекции. Если массив в настоящее время не является коллекцией, он будет преобразован в коллекцию с одним элементом.

 $ obj -> unshift ( ' value ' )
    -> unshift ( ' value1 ' , ' value2 ' , ' value3 ' );

Примечание. Вы можете передать ArrayObject как значения.

сдвиг()

Вытаскивает первый предмет из коллекции.
Если массив в настоящее время не является коллекцией, он будет преобразован в коллекцию с одним элементом.

 $ item = $ obj -> shift (); // ArrayObject

push ($ val [, $ val ...])

Добавляет один или несколько элементов в конце коллекции. Если массив в настоящее время не является коллекцией, он будет преобразован в коллекцию с одним элементом.

 $ obj -> push ( ' value ' )
    -> push ( ' value1 ' , ' value2 ' , ' value3 ' );

Примечание. Вы можете передать ArrayObject как значения.

поп ()

Вытаскивает последний предмет из коллекции.
Если массив в настоящее время не является коллекцией, он будет преобразован в коллекцию с одним элементом.

 $ item = $ obj -> pop ();  // ArrayObject

Внося

Взносы приветствуются, пожалуйста, отправьте запрос или создайте проблему. Ваш отправленный код должен быть отформатирован с использованием стандартов PSR-1/PSR-2.

О

Автор: Джоди Данлоп
Лицензия: MIT

Расширять