index.md

Information

This package provide a small set of useful utilities for simpler development.

Installation

The simplest way to install apicart/php-utils is using Composer:

$ composer require apicart/php-utils

Utils

Arrays

Array merging

<?php 

use Apicart\Utils\Arrays\Arrays;

$one = ['a' => 1, 'b' => [1, 2, 3], 'c' => false];
$two = ['c' => true, 'd' => ['a']];

$result = Arrays::merge($two, $one);
// $result = ['a' => 1, 'b' => [1, 2, 3], 'c' => true, 'd' => ['a']];

Array accesing

<?php

use Apicart\Utils\Arrays\Arrays;

$data = [
	'id' => 12,
	'tags' => ['first', 'second', 'third'],
	'parameters' => [
		[
			'key' => 'billingAddress',
			'value' => [
				'firstName' => 'John',
				'lastName' => 'Doe',
			],
		],
		[
			'key' => 'paymentMethod',
			'value' => 'PPL',
		],
	],
	'tree' => [
		'left' => [
			'node' => 'Left node',
		],
		'right' => [
			'node' => 'Right node',
		],
	],
];

Arrays::get($data, 'id'); // 12
Arrays::get($data, 'tags.1'); // "second"
Arrays::get($data, 'parameters.key:billingAddress.value.firstName'); // "John"
Arrays::get($data, 'parameters.key:paymentMethod.value'); // "PPL"
Arrays::get($data, 'tree.right.node'); // "Right node"

Arrays::get($data, 'tree.center.node'); // null
Arrays::get($data, 'tree.center.node', 'Default value'); // Default value

Array reference

<?php

use Apicart\Utils\Arrays\Arrays;

$data = [
	'tree' => [
		'left' => [
			'node' => 'Left node',
		],
	],
];

$nodeReference = & Arrays::getReference($data, 'tree.left.node');
$nodeReference = 'Foo';
echo $data['tree']['left']['node']; // "Foo"

Array set

<?php

use Apicart\Utils\Arrays\Arrays;

$data = [
	'id' => 12,
	'tree' => [
		'left' => [
			'node' => 'Left node',
		],
	],
];

$result = Arrays::set($data, 'id', 1);
echo $result['id']; // 1

$result = Arrays::set($data, 'tree.left.position', 3);
echo $result['tree']['left']['position']; // 3

$result = Arrays::set($data, 'foo', 'bar');
echo $result['foo']; // "bar"

Collections

<?php

use Apicart\Utils\Arrays\Collection;

$collection = new Collection(function (){
	return [1, 2, 3]; // or use some service for lazy loading
});

foreach ($collection as $item){
	echo $item; // 1, 2, 3
}

Hashes

Generating

<?php

use Apicart\Utils\Hashes\Hashes;

$hash = Hashes::generate();
// $hash = 'e6de5f4cc9fa29fc34c23fba0d499da8';

$hash = Hashes::generate(10, 'A-Z');
// $hash = 'AKUTHNEFPL';

SQL

Query Builder

<?php

use Apicart\Utils\Sql\QueryBuilder;

$queryBuilder = QueryBuilder::create()
    ->select('a.id, a.name')
    ->addSelect('a.price')
    ->from('table', 'a')
    ->innerJoin('inner_table', 'b', 'b.id = a.id')
    ->leftJoin('left_table', 'c', 'c.id = b.id')
    ->where('a.id IN (:ids)')
    ->andWhere('b.id = :bId')
    ->orWhere('(c.id IS NULL OR c.id > :minId')
    ->setParameters([
        'ids' => [1, 2, 3],
        'bId' => 'aaa',
    ])
    ->setParameter('minId', 0);

$sql = $queryBuilder->getSql();
$parameters = $queryBuilder->getParameters();