README

A PHP library providing enhanced array and iteration utility functions for array manipulation, transformation, and validation.

Installation

Install the package via Composer:

composer require vairogs/functions-iteration

Requirements

PHP 8.4 or higher

Usage

There are two ways to use this package: via the Functions class or by directly using the traits.

Using the Functions Class

The Functions class provides a wide range of array and iteration utility functions.

use Vairogs\Functions\Iteration\Functions;

// Create a new Functions instance
$iteration = new Functions();

// Check if an array is associative
$isAssoc = $iteration->isAssociative(['key' => 'value']); // Returns true
$isAssoc = $iteration->isAssociative([1, 2, 3]); // Returns false

// Make a one-dimensional array multi-dimensional
$multiDim = $iteration->makeMultiDimensional([1, 2, 3]); // Returns [[1], [2], [3]]

// Get unique values from an array
$unique = $iteration->unique([1, 2, 2, 3, 3, 3]); // Returns [1, 2, 3]

// Check if an array is multi-dimensional
$isMultiDim = $iteration->isMultiDimensional([[1], [2]]); // Returns true

// Convert an array to a string
$string = $iteration->arrayToString(['a', 'b', 'c']); // Returns "a,b,c"

// JSON encode with error handling
$json = $iteration->jsonEncode(['key' => 'value']); // Returns '{"key":"value"}'

Using Traits Directly

Alternatively, you can use the traits directly in your own classes:

use Vairogs\Functions\Iteration\Traits\_IsAssociative;
use Vairogs\Functions\Iteration\Traits\_MakeMultiDimensional;
use Vairogs\Functions\Iteration\Traits\_Unique;

class MyClass
{
    // Import the traits you need
    use _IsAssociative;
    use _MakeMultiDimensional;
    use _Unique;

    public function doSomething(): void
    {
        // Use the methods directly
        $isAssoc = $this->isAssociative(['key' => 'value']);
        $multiDim = $this->makeMultiDimensional([1, 2, 3]);
        $unique = $this->unique([1, 2, 2, 3, 3, 3]);
    }
}

Note that some traits may depend on other helper traits. The Functions class handles these dependencies for you, but if you use the traits directly, you may need to include these helper traits as well.

Features

For a complete list of all functions available in this package, see Features.

License

This package is licensed under the BSD-3-Clause License.

About Vairogs

This package is part of the vairogs/vairogs project - a comprehensive PHP library and Symfony bundle that provides a collection of utilities, components, and integrations for Symfony applications.

The main project includes:

• Various utility functions and components
• Doctrine ORM tools and extensions
• API Platform integrations
• Symfony bundle for easy configuration
• And much more

If you find this Iteration component useful, you might want to check out the full Vairogs project for additional tools and utilities that can enhance your Symfony application development.

To install the complete package:

composer require vairogs/vairogs