https://github.com/pflorek/php-elevator

PHP Elevator
https://github.com/pflorek/php-elevator

array composer flatten materialized-paths php tree

Last synced: 9 days ago
JSON representation

PHP Elevator

• Host: GitHub
• URL: https://github.com/pflorek/php-elevator
• Owner: pflorek
• License: mit
• Created: 2017-03-15T21:04:23.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-16T21:42:27.000Z (over 5 years ago)
• Last Synced: 2024-10-19T01:13:15.880Z (4 months ago)
• Topics: array, composer, flatten, materialized-paths, php, tree
• Language: PHP
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Elevator

[![Build Status](https://travis-ci.org/pflorek/php-elevator.svg?branch=master)](https://travis-ci.org/pflorek/php-elevator)

[![Coverage Status](https://coveralls.io/repos/github/pflorek/php-elevator/badge.svg?branch=master)](https://coveralls.io/github/pflorek/php-elevator?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pflorek/php-elevator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/pflorek/php-elevator/?branch=master)

[![Latest Stable Version](https://poser.pugx.org/pflorek/elevator/v/stable)](https://packagist.org/packages/pflorek/elevator)

[![Total Downloads](https://poser.pugx.org/pflorek/elevator/downloads)](https://packagist.org/packages/pflorek/elevator)

[![Latest Unstable Version](https://poser.pugx.org/pflorek/elevator/v/unstable)](https://packagist.org/packages/pflorek/elevator)

[![License](https://poser.pugx.org/pflorek/elevator/license)](https://packagist.org/packages/pflorek/elevator)

[![Monthly Downloads](https://poser.pugx.org/pflorek/elevator/d/monthly)](https://packagist.org/packages/pflorek/elevator)

[![Daily Downloads](https://poser.pugx.org/pflorek/elevator/d/daily)](https://packagist.org/packages/pflorek/elevator)

[![composer.lock](https://poser.pugx.org/pflorek/elevator/composerlock)](https://packagist.org/packages/pflorek/elevator)

This library provides a simple way to elevate a map (associative array) 

to a tree or to flatten a tree to a map (associative array). The tree's 

node keys are the tokens of the map's materialized path separated by

a delimiter.

This library comes handy to map flat lists like SQL results to

documents. The result's column name could be a materialized path of

the target document. You can pass a result row to `Elevator::up` and

proceed marshalling by passing the elevated tree to a JSON or XML

serializer. On unmarshalling just pass the deserialized array tree

to `Elevator::down` and feed e.g. a SQL statement.

## Usage

### Elevate

Elevate a map with materialized paths to a tree:

```PHP

use PFlorek\Elevator\Elevator;

use PFlorek\Elevator\ElevatorFactory;

use function \PFlorek\Elevator\array_elevate;

$flattened = [

    'World.Asia.Afghanistan.0' => '...',

    'World.Africa' => true,

    'World.Antarctica' => -25.2,

    'World.Europe' => new \stdClass(),

    'World.North America' => [],

];

// object oriented

$factory = ElevatorFactory::getInstance();

$elevator = $factory->create();

$elevator->up($flattened);

// or functional

$elevated = array_elevate($flattened);

var_dump($elevated);

//returns ["World"] => array(5) {

//  ["Asia"] => array(1) {

//    ["Afghanistan"] => array(1) {

//      [0] => string(3) "..."

//    }

//  }

//  ["Africa"] => bool(true)

//  ["Antarctica"] => float(-25.2)

//  ["Europe"]=> object(stdClass)#298 (0) {}

//  ["North America"]=> []

//}

```

### Flatten

Flattens a tree to a map which keys are the materialized path of the node's keys:

```PHP

use PFlorek\Elevator\Elevator;

use PFlorek\Elevator\ElevatorFactory;

use function \PFlorek\Elevator\array_flatten;

$elevated = [

    'World' => [

        'Asia' => [

            'Afghanistan' => [

                '...'

            ]

        ],

        'Africa' => true,

        'Antarctica' => -25.2,

        'Europe' => new \stdClass(),

        'North America' => [],

    ]

];

// object oriented

$factory = ElevatorFactory::getInstance();

$elevator = $factory->create();

$elevator->down($flattened);

// or functional

$flattened = array_flatten($elevated);

var_dump($flattened);

//returns array(5) {

//  ["World.Asia.Afghanistan.0"] => string(3) "..."

//  ["World.Africa"] => bool(true)

//  ["World.Antarctica"] => float(-25.2)

//  ["World.Europe"] => object(stdClass) (0) { }

//  ["World.North America"] => array(0) { }

//}

```

## Installation

Use [Composer] to install the package:

```bash

composer require pflorek/elevator

```

## Authors

* [Patrick Florek]

## Contribute

Contributions are always welcome!

* Report any bugs or issues on the [issue tracker].

* You can download the sources at the package's [Git repository].

## License

All contents of this package are licensed under the [MIT license].

[Composer]: https://getcomposer.org

[Git repository]: https://github.com/pflorek/php-elevator

[issue tracker]: https://github.com/pflorek/php-elevator/issues

[MIT license]: LICENSE

[Patrick Florek]: https://github.com/pflorek