https://github.com/vasiliy-makogon/php-collection

Cover (PHP Collection) - library for convenient and flexible work with arrays in object-oriented representation.
https://github.com/vasiliy-makogon/php-collection

array-object array-wrapper arrayobject collection cover-array php-array php-array-collection php-array-cover php-array-object php-array-wrapper php-collection

Last synced: about 1 month ago
JSON representation

Cover (PHP Collection) - library for convenient and flexible work with arrays in object-oriented representation.

• Host: GitHub
• URL: https://github.com/vasiliy-makogon/php-collection
• Owner: Vasiliy-Makogon
• Created: 2018-10-24T14:19:30.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-17T07:32:23.000Z (about 2 months ago)
• Last Synced: 2024-11-17T08:23:08.485Z (about 2 months ago)
• Topics: array-object, array-wrapper, arrayobject, collection, cover-array, php-array, php-array-collection, php-array-cover, php-array-object, php-array-wrapper, php-collection
• Language: PHP
• Homepage:
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Cover Array](logo.jpg)

# Объектный массив на PHP (PHP-коллекция)

Набор классов для удобной и гибкой работы с массивами в объектно-ориентированном

представлении. Фактически, это "объектный массив", которого так не хватает в PHP.

## Требования

PHP >= 8.0

## Установка

```

composer require krugozor/cover

```

# Документация

## Введение

Базовый класс называется `CoverArray`.

Вы можете создать класс, наследуемый от `CoverArray` или использовать `CoverArray` без наследования.

В данной документации, как и в unit-тестах, используется тип данных `NewTypeArray`,

наследуемый от `CoverArray`:

```php

class NewTypeArray extends CoverArray {}

```

Это сделано для того, что бы продемонстрировать гибкость данного решения.

Объектов, производных от `CoverArray`, в вашей программе может быть много, они могут отличаться

на концептуальном уровне и содержать в себе разную логику работы с данными.

Например, объекты класса `CoverArray` можно использовать просто как "объектный массив"

для замещения стандартного `array` в повседневной работе,

в свою очередь любой другой тип, производный от `CoverArray`, может служить, например, неким подобием DTO

или попросту быть независимым типом данных для предотвращения "выстрела в ногу":

```php

function foo(NewTypeArray $cover) {}

```

## Инициализация

```php

class NewTypeArray extends CoverArray {}

$cover = new NewTypeArray([

    'firstName' => 'Vasiliy',

    'lastName' => 'Ivanov',

    'languages' => [

        'backend' => ['PHP', 'MySql'],

        'frontend' => ['HTML', 'CSS1', 'JavaScript', 'CSS2', 'CSS3']

    ],

]);

var_dump($cover);

```

Результат:

```

object(NewTypeArray)#2 (1) {

  ["data":protected]=>

  array(3) {

    ["firstName"]=>

    string(7) "Vasiliy"

    ["lastName"]=>

    string(6) "Ivanov"

    ["languages"]=>

    object(NewTypeArray)#4 (1) {

      ["data":protected]=>

      array(2) {

        ["backend"]=>

        object(NewTypeArray)#5 (1) {

          ["data":protected]=>

          array(2) {

            [0]=>

            string(3) "PHP"

            [1]=>

            string(5) "MySql"

          }

        }

        ["frontend"]=>

        object(NewTypeArray)#6 (1) {

          ["data":protected]=>

          array(5) {

            [0]=>

            string(4) "HTML"

            [1]=>

            string(4) "CSS1"

            [2]=>

            string(10) "JavaScript"

            [3]=>

            string(4) "CSS2"

            [4]=>

            string(4) "CSS3"

          }

        }

      }

    }

  }

}

```

Как видно, все переданные в конструктор массивы рекурсивно преобразовались в объекты типа `NewTypeArray`.

Это поведение гарантирует, что **любой массив, попадающий в хранилище, получит "обложку" в виде

объекта того класса, который его аккумулирует**.

Данные всех созданных объектов аккуратно сложились в protected-свойство `CoverArray::$data`, что обеспечивает инкапсуляцию

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

## Примеры

Тут представлена лишь малая доля возможных примеров работы с объектным массивом `CoverArray`.

Изучите API класса для более углублённого понимания.

#### Пример:

```php

$value = $cover

    ->get('languages.frontend')

    ->filter(function ($value) {

        return preg_match('~CSS~', $value);

    })

    ->implode(', ');

var_dump($value);

```

Результат:

```

string(16) "CSS1, CSS2, CSS3"

```

#### Пример:

```php

$value = $cover

    ->get('languages.frontend')

    ->append('HTML 5', 'jQuey')

    ->getDataAsArray();

var_dump($value);

```

Результат:

```

array(7) {

  [0]=>

  string(4) "HTML"

  [1]=>

  string(4) "CSS1"

  [2]=>

  string(10) "JavaScript"

  [3]=>

  string(4) "CSS2"

  [4]=>

  string(4) "CSS3"

  [5]=>

  string(6) "HTML 5"

  [6]=>

  string(5) "jQuey"

}

```

#### Пример:

```php

var_dump($cover['languages']['backend'][0]);

var_dump($cover->languages->backend->item(0));

var_dump($cover->get('languages.backend.0'));

var_dump($cover->get('languages')->item('backend')[0]);

var_dump($cover->get('languages')['backend']->item(0));

```

Результат:

```

string(3) "PHP"

string(3) "PHP"

string(3) "PHP"

string(3) "PHP"

string(3) "PHP"

```

#### Пример:

```php

var_dump($cover->get('languages.backend')->getFirst());

var_dump($cover->get('languages.backend')->getLast());

```

Результат:

```

string(3) "PHP"

string(5) "MySql"

```

#### Пример:

```php

var_dump(serialize($cover->get('languages.backend')));

```

Результат:

```

string(54) "O:12:"NewTypeArray":2:{i:0;s:3:"PHP";i:1;s:5:"MySql";}"

```

#### Пример:

```php

$value = $cover->get('languages')->map(function (CoverArray $lang, string $key) {

    return sprintf(

        "\n\t
%s (%s):\n\t%s\n\t
",

        $key,

        $lang->count(),

        $lang->map(fn($value): string => "\t
$value
")->implode("\n\t")

    );

})

    ->prepend("\n
")

    ->append("\n
")

    ->implode('');


var_dump($value);

```

Результат:

```

string(180) "



        
backend (2):

                

PHP

                
MySql

        

        
frontend (5):

                

HTML

                
CSS1

                
JavaScript

                
CSS2

                
CSS3

        

"

```


#### Пример:

```php

$value = NewTypeArray::fromExplode(',', '1,1,2,1,2,2,1,,1,,,2')

    ->unique()

    ->filter()

    ->implode(',');

var_dump($value);

```

Результат:

```

string(3) "1,2"

```

#### Пример:

```php

var_dump($cover->get('languages.backend')->getDataAsArray());

var_dump($cover->get('languages.backend')->reverse()->getDataAsArray());

```

Результат:

```

array(2) {

  [0]=>

  string(3) "PHP"

  [1]=>

  string(5) "MySql"

}

array(2) {

  [0]=>

  string(5) "MySql"

  [1]=>

  string(3) "PHP"

}

```

#### Пример:

```php

var_dump($cover->get('languages.backend')->in('PHP'));

```

Результат:

```

bool(true)

```

#### Пример:

```php

$value = $cover->get('languages.frontend')->diff(

    ['HTML'],

    ['CSS1', 'CSS2', 'CSS3']

)->getDataAsArray();

var_dump($value);

```

или даже так:

```php

$value = $cover->get('languages.frontend')->diff(

    new NewTypeArray(['HTML']),

    new NewTypeArray(['CSS1', 'CSS2', 'CSS3'])

)->getDataAsArray();

```

Результат:

```

array(1) {

  [2]=>

  string(10) "JavaScript"

}

```

#### Пример:

```php

$value = $cover->get('languages')->mapRecursive(

    fn(mixed $value, mixed $key): string => "$key: $value"

)->getDataAsArray();

var_dump($value);

```

Результат:

```

array(2) {

  ["backend"]=>

  array(2) {

    [0]=>

    string(6) "0: PHP"

    [1]=>

    string(8) "1: MySql"

  }

  ["frontend"]=>

  array(5) {

    [0]=>

    string(7) "0: HTML"

    [1]=>

    string(7) "1: CSS1"

    [2]=>

    string(13) "2: JavaScript"

    [3]=>

    string(7) "3: CSS2"

    [4]=>

    string(7) "4: CSS3"

  }

}

```