php flatten

php-ratakan

Sebuah fungsi utilitas untuk meratakan array multidimensi dan traversable menjadi array satu dimensi, mempertahankan kunci dan menggabungkannya dengan pemisah yang dapat disesuaikan untuk dari kunci yang sepenuhnya memenuhi syarat dalam array akhir.

Instalasi

  composer require sarhan/php-flatten

Penggunaan

Contoh 1

 use Sarhan  Flatten  Flatten ;

$ multiArray = [
    ' say ' => ' what ' ,
    ' hi ' => [ ' de ' => ' Hallo ' , ' es ' => ' Hola ' ]
];

/*
Flatten::__construct(
    string $separator = '.',
    string $prefix = '',
    int $flags = 0
)
*/
$ flatten = new Flatten ();

// Flatten::flattenToArray is provided for convinience. It internally
// calls Flatten::flatten and converts it's output, which is a 1-dimensional
// iterator, into a 1-dimensional array.
$ flattened = $ flatten -> flattenToArray ( $ multiArray );

// Flatten::unflattenToArray is provided for convinience. It internally
// calls Flatten::unflatten and converts it's output, which is a recursive
// generator structure, into a multi-dimensional array.
$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flattened == [
    ' say ' => what
    ' hi.de ' => Hallo
    ' hi.es ' => Hola
]);

assert ( $ unflattened == $ multiArray );

Contoh 2

Pemisah Khusus dan awalan awal

 use Sarhan  Flatten  Flatten ;

$ allowAccess = [
    ' root ' => false ,
    ' var ' => [ ' log ' => [ ' nginx ' => true , ' apt ' => false ], ' www ' => true ],
];

$ flatten = new Flatten (
  ' / ' ,  // separator
  ' / '   // prefix
);

$ flattened = $ flatten -> flattenToArray ( $ allowAccess );

$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flatten == [
    ' /root ' => false ,
    ' /var/log/nginx ' => true ,
    ' /var/log/apt ' => false ,
    ' /var/www ' => true
]);

assert ( $ unflattened == $ allowAccess );

Contoh 3

Perhatikan bahwa awalan tidak akan dipisahkan di FQkeys. Jika harus dipisahkan, pemisah harus ditambahkan pada string awalan.

 use Sarhan  Flatten  Flatten ;

$ api = [
    ' category ' => [ ' health ' => 321 , ' sport ' => 769 , ' fashion ' => 888 ],
    ' tag ' => [ ' soccer ' => 7124 , ' tennis ' => [ ' singles ' => 9833 , ' doubles ' => 27127 ] ],
];

$ flatten = new Flatten ( ' / ' , ' https://api.dummyhost.domain/ ' );

$ flattened = $ flatten -> flattenToArray ( $ api );

$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flattened == [
    ' https://api.dummyhost.domain/category/health ' => 321 ,
    ' https://api.dummyhost.domain/category/sport ' => 769 ,
    ' https://api.dummyhost.domain/category/fashion ' => 888 ,
    ' https://api.dummyhost.domain/tag/soccer ' => 7124 ,
    ' https://api.dummyhost.domain/tag/tennis/singles ' => 9833 ,
    ' https://api.dummyhost.domain/tag/tennis/doubles ' => 27127
]);

assert ( $ unflattened == $ api );

Contoh 4

Kunci numerik diperlakukan sebagai kunci asosiatif.

Catatan: Perilaku ini dapat diubah menggunakan tanda. Lihat FLAG_NUMERIC_NOT_FLATTENED

 use Sarhan  Flatten  Flatten ;

$ nutrition = [
    ' nutrition ' ,
    ' fruits ' => [ ' oranges ' , ' apple ' , ' banana ' ],
    ' veggies ' => [ ' lettuce ' , ' broccoli ' ],
];

$ flatten = new Flatten ( ' - ' );

$ flattened = $ flatten -> flattenToArray ( $ nutrition );

$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flattened == [
    ' 0 ' => ' nutrition ' ,
    ' fruits-0 ' => ' oranges ' ,
    ' fruits-1 ' => ' apple ' ,
    ' fruits-2 ' => ' banana ' ,
    ' veggies-0 ' => ' lettuce ' ,
    ' veggies-1 ' => ' broccoli '
]);

assert ( $ unflattened == $ nutrition );

Bendera

FLAG_NUMERIC_NOT_FLATTENED

Menonaktifkan nilai perataan dengan tombol numerik (integer).

Nilai-nilai tersebut akan dibungkus dalam array (mempertahankan kuncinya) dan dikaitkan dengan FQK induk.

 use Sarhan  Flatten  Flatten ;

$ examples = [
    ' templates ' => [
      [ ' lang ' => ' js ' , ' template ' => " console.log('%s'); " ],
      [ ' lang ' => ' php ' , ' template ' => ' echo "%s"; ' ]
    ],
    ' values ' => [ 3 => ' hello world ' , 5 => ' what is your name? ' ]
];

$ flatten = new Flatten (
  ' . ' ,
  ' examples. ' ,
  Flatten:: FLAG_NUMERIC_NOT_FLATTENED
);

$ flattened = $ flatten -> flattenToArray ( $ examples );

$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flattened == [
    ' examples.templates ' => [
        [
            ' lang ' => ' js ' ,
            ' template ' => ' console.log( ' %s ' ) ' ;
        ],
        [
            ' lang ' => ' php ' ,
            ' template ' => ' echo "%s" '
        ]
    ],
    ' examples.values ' => [
        3 => ' hello world ' ,
        5 => ' what is your name? '
    ]
]);

assert ( $ unflattened == $ examples );

Kunci numerik (integer) tingkat atas juga akan dikembalikan ke dalam array yang ditetapkan ke awalan yang diteruskan.

 use Sarhan  Flatten  Flatten ;

$ seats = [
  ' A1 ' ,
  ' A2 ' ,
  ' B1 ' ,
  ' B2 ' ,
  ' _reserved ' => [ ' A1 ' , ' B1 ' ],
  ' _blocked ' => [ ' B2 ' ]
];

$ flatten = new Flatten (
  ' _ ' ,
  ' seats ' ,
  Flatten:: FLAG_NUMERIC_NOT_FLATTENED
);

$ flattened = $ flatten -> flattenToArray ( $ seats );

$ unflattened = $ flatten -> unflattenToArray ( $ flattened );

assert ( $ flattened == [
    ' seats ' => [ ' A1 ' , ' A2 ' , ' B1 ' , ' B2 ' ],
    ' seats_reserved ' => [ ' A1 ' , ' B1 ' ],
    ' seats_blocked ' => [ ' B2 ' ]
]);

assert ( $ unflattened == $ seats );