PHPackages                             yiisoft/arrays - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/arrays

ActiveLibrary[Framework](/categories/framework)

yiisoft/arrays
==============

Yii Array Helper

3.2.1(5mo ago)562.0M—7.9%27[4 issues](https://github.com/yiisoft/arrays/issues)[2 PRs](https://github.com/yiisoft/arrays/pulls)20BSD-3-ClausePHPPHP 8.1 - 8.5CI passing

Since Feb 2Pushed 3mo ago18 watchersCompare

[ Source](https://github.com/yiisoft/arrays)[ Packagist](https://packagist.org/packages/yiisoft/arrays)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-arrays/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (6)Versions (13)Used By (20)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Arrays
==========

[](#yii-arrays)

[![Latest Stable Version](https://camo.githubusercontent.com/6afefb7361f22279f55d3281bdfcd846be6c12de0799e0e844f489da6a6f11b8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f6172726179732f76)](https://packagist.org/packages/yiisoft/arrays)[![Total Downloads](https://camo.githubusercontent.com/33d24e63351d356440c5c3101381b0ef3079af8f4cc8f56483e522c07932355a/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f6172726179732f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/arrays)[![Build status](https://github.com/yiisoft/arrays/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/arrays/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/cee9a0de9bd4d3b9980c2320ff9daa34b31113913ae68c5bfb4140425b2e5277/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f6172726179732f67726170682f62616467652e7376673f746f6b656e3d534d544d4e46344b5439)](https://codecov.io/gh/yiisoft/arrays)[![Mutation testing badge](https://camo.githubusercontent.com/92d6f5e5d2a9c7fc4e670e1426c5bed8cd0ab85e1b837219f0f6e911028da48e/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532466172726179732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/arrays/master)[![static analysis](https://github.com/yiisoft/arrays/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/arrays/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/5c1bb32b240bb986cc5f70cb3244bd1c6f62a2c7e255a8f52c310dc085d7bcf7/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f6172726179732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/arrays)

The package provides:

- `ArrayHelper` that has static methods to work with arrays;
- `ArraySorter` that has static methods for sort arrays;
- `ArrayAccessTrait` provides the implementation for [\\IteratorAggregate](https://www.php.net/manual/class.iteratoraggregate), [\\ArrayAccess](https://www.php.net/manual/class.arrayaccess) and [\\Countable](https://www.php.net/manualn/class.countable.php);
- `ArrayableInterface` and `ArrayableTrait` for use in classes who want to support customizable representation of their instances.

Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

```
composer require yiisoft/arrays
```

ArrayHelper usage
-----------------

[](#arrayhelper-usage)

Array helper methods are static so usage is like the following:

```
$username = \Yiisoft\Arrays\ArrayHelper::getValue($_POST, 'username');
```

Overall the helper has the following method groups.

### Getting data

[](#getting-data)

- getValue
- getValueByPath
- getColumn
- getObjectVars

### Setting data

[](#setting-data)

- addValue
- addValueByPath
- setValue
- setValueByPath

### Removing data

[](#removing-data)

- remove
- removeByPath
- removeValue

### Detecting array types

[](#detecting-array-types)

- isIndexed
- isAssociative

### HTML encoding and decoding values

[](#html-encoding-and-decoding-values)

- htmlDecode
- htmlEncode

### Testing against arrays

[](#testing-against-arrays)

- isIn
- isSubset

### Transformation

[](#transformation)

- index
- group
- filter
- map
- merge
- parametrizedMerge
- renameKey
- toArray

### Other

[](#other)

- keyExists
- pathExists

ArraySorter usage
-----------------

[](#arraysorter-usage)

Array sorter has one static method which usage is like the following:

```
\Yiisoft\Arrays\ArraySorter::multisort($data, ['age', 'name'], [SORT_ASC, SORT_DESC]);
```

ArrayAccessTrait usage
----------------------

[](#arrayaccesstrait-usage)

`ArrayAccessTrait` provides the implementation for [\\IteratorAggregate](https://www.php.net/manual/class.iteratoraggregate), [\\ArrayAccess](https://www.php.net/manual/class.arrayaccess) and [\\Countable](https://www.php.net/manualn/class.countable.php).

Note that `ArrayAccessTrait` requires the class using it contain a property named `data` which should be an array. The data will be exposed by ArrayAccessTrait to support accessing the class object like an array.

Example of use:

```
use \Yiisoft\Arrays\ArrayAccessTrait;

class OfficeClassification implements \IteratorAggregate, \ArrayAccess, \Countable
{
    use ArrayAccessTrait;

    public array $data = [
        'a' => 'Class A',
        'b' => 'Class B',
        'c' => 'Class C',
    ];
}

$classification = new OfficeClassification();

echo 'Count classes: ' . $classification->count() . "\n"; // 3

$iterator = $classification->getIterator();
while ($iterator->valid()) {
    echo $iterator->current() . "\n"; // Class A, Class B, Class C
    $iterator->next();
}
```

ArrayableInterface and ArrayableTrait usage
-------------------------------------------

[](#arrayableinterface-and-arrayabletrait-usage)

`ArrayableInterface` and its implementation `ArrayableTrait` intended for use in classes who want to support customizable representation of their instances.

Example of use:

```
use \Yiisoft\Arrays\ArrayableTrait;
use \Yiisoft\Arrays\ArrayableInterface;

class Car implements ArrayableInterface
{
    use ArrayableTrait;

    public string $type = 'Crossover';
    public string $color = 'Red';
    public int $torque = 472;
}

$car = new Car();

$data = $car->toArray(['type', 'color']); // ['type' => 'Crossover', 'color' => 'Red']
```

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Arrays is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

65

—

FairBetter than 99% of packages

Maintenance74

Regular maintenance activity

Popularity56

Moderate usage in the ecosystem

Community47

Growing community involvement

Maturity77

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~251 days

Recently: every ~298 days

Total

8

Last Release

173d ago

Major Versions

1.0.1 → 2.0.02021-10-23

2.1.0 → 3.0.02023-01-12

PHP version history (4 changes)1.0.0PHP ^7.4|^8.0

3.0.0PHP ^8.0

3.2.0PHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0

3.2.1PHP 8.1 - 8.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (69 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (55 commits)")[![hiqsol](https://avatars.githubusercontent.com/u/11820365?v=4)](https://github.com/hiqsol "hiqsol (9 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (9 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (8 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![machour](https://avatars.githubusercontent.com/u/304450?v=4)](https://github.com/machour "machour (5 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (4 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (4 commits)")[![Arhell](https://avatars.githubusercontent.com/u/26163841?v=4)](https://github.com/Arhell "Arhell (2 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (2 commits)")[![germanow](https://avatars.githubusercontent.com/u/5995709?v=4)](https://github.com/germanow "germanow (2 commits)")[![mapeveri](https://avatars.githubusercontent.com/u/6276555?v=4)](https://github.com/mapeveri "mapeveri (2 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (2 commits)")[![Tigrov](https://avatars.githubusercontent.com/u/8563175?v=4)](https://github.com/Tigrov "Tigrov (2 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![SilverFire](https://avatars.githubusercontent.com/u/4499203?v=4)](https://github.com/SilverFire "SilverFire (1 commits)")

---

Tags

arrayarrayshacktoberfestyii3helperarrayyii

###  Code Quality

TestsPHPUnit

Static AnalysisRector

### Embed Badge

![Health badge](/badges/yiisoft-arrays/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-arrays/health.svg)](https://phpackages.com/packages/yiisoft-arrays)
```

###  Alternatives

[yiisoft/yii

Yii Web Programming Framework

4.8k5.6M262](/packages/yiisoft-yii)[yiisoft/yii2-queue

Yii2 Queue Extension which supports queues based on DB, Redis, RabbitMQ, Beanstalk, SQS, and Gearman

1.1k10.4M155](/packages/yiisoft-yii2-queue)[yiisoft/yii2-imagine

The Imagine integration for the Yii framework

2865.4M275](/packages/yiisoft-yii2-imagine)[yiisoft/strings

Yii Strings Helper

492.6M38](/packages/yiisoft-strings)[dragon-code/support

Support package is a collection of helpers and tools for any project.

238.7M101](/packages/dragon-code-support)[omnilight/yii2-scheduling

Scheduling extension for Yii2 framework

3181.0M7](/packages/omnilight-yii2-scheduling)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
