sbwerewolf/language-specific

Library for using PHP specific features

8.0.1 2024-06-15 09:59 UTC

Requires

• php: >=8.0
• ext-json: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• phpunit/phpunit: ^9.5

MIT

• Nikolay Volkhin

README

composer require sbwerewolf/language-specific ^7.2

Features

ArrayHandler with ValueHandler are purpose to safe access to array elements and type-safe using of elements values

With ArrayHandler class you do not need to use

array_key_exists()
intval()
boolval()
floatval()

and others

With ValueHandler class you get that type exact you want.

Use-cases

Get database response with proper types

use LanguageSpecific\ArrayHandler;

$connection = new PDO ($dsn,$login,$password);

$command = $connection->
    prepare('select name,salary from employee'
            . ' ORDER BY salary DESC LIMIT 1');
$command->execute();
$data = $command->fetch(PDO::FETCH_ASSOC);
/*
$data =
    array (
        'name' => 'Mike',
        'salary'=> 19999.99
    );
*/

$employee = new ArrayHandler($data);
echo "The highest paid employee is {$employee->get('name')->str()}"
    . ", with salary of {$employee->get('salary')->int()}$";
/*
The highest paid employee is Mike, with salary of 19999$
*/

Library methods of version 7.2

raw() - returns original array

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler(
    [0 => 'first',
    'index' => 20, 
    3 => 'last',]);
    
$original = $data->raw();

var_export($original);
/*
array (
  0 => 'first',
  'index' => 20,
  3 => 'last',
)
*/

has($key = null) - flag that array has the index (key)

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler([0=>1]);
$data->has(); // true
// array has at least one index (element)

$data = new ArrayHandler([0=>1]);
$data->has(0); // true
// array has index 0

$data = new ArrayHandler([2=>3]);
$data->has('4'); // false
// array not has index '4'

get($key = null) - Get element by index or without it

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler(
    [0 => 'first',
    'index' => 20, 
    3 => 'last',]);

$data->get()->asIs();
/* 'first' */
$data->get()->has();
/* true */

$data->get('no-exists')->asIs();
/* NULL */
$data->get('no-exists')->has();
/* false */

$data->get('index')->asIs();
/* 20 */
$data->get('index')->has();
/* true */

$data->get(99)->asIs();
/* NULL */
$data->get(99)->has();
/* false */

$data->get(3)->asIs();
/* 'last' */
$data->get(3)->has();
/* true */

isUndefined() - flag that exemplar value is undefined

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler(['first' => ['A' => 1], 'next' => ['B'=>2],
    'last' => ['C'=>3],]);

$data->pull('first')->isUndefined(); // false
$data->pull('begin')->isUndefined(); // true

pull($key = null) - get array handler for nested array

use LanguageSpecific\ArrayHandler;

$level4 = [-4 =>
    ['over' => ['and' => ['over' => ['again' => ['for always']]]]]];
$level3 = [-3 => $level4, 'some' => 'other',];
$level2 = [-2 => $level3];
$level1 = [-1 => $level2, 'other' => ['content'], 'any'];
$level0 = [$level1];

$data = new ArrayHandler($level0);

$data->pull(0)->pull(-1)->pull(-2)
                ->pull(-3)->pull(-4)->pull('over')
                ->pull('and')->pull('over')->pull('again')
                ->isUndefined(); // false

$data->pull(0)->pull(-1)->pull(-2)
                ->pull(-3)->pull(-4)->pull('over')
                ->pull('and')->pull('over')->pull('again')
                ->get()->str(); // 'for always'

$data->pull(0)->pull(-1)->pull(-2)
                ->pull(-3)->pull(-4
                )->pull(-5)->isUndefined(); // true

pulling() - iterate through array and get handler for each element

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler([['first', 'next', 'last',],
    ['A','B','C',], ['1','2','3',]]);

foreach ($data->pulling() as $next) {
    /* @var $next ArrayHandler */
    echo PHP_EOL. var_export($next->raw());
}

/*
array (
  0 => 'first',
  1 => 'next',
  2 => 'last',
)
array (
  0 => 'A',
  1 => 'B',
  2 => 'C',
)
array (
  0 => '1',
  1 => '2',
  2 => '3',
)
*/

asIs() - Get value as it is

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler('1.1');
$data->get()->asIs(); // '1.1'

int() - to integer

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler('1.1');
$data->get()->int(); // 1

double() to double

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler('1.1');
$data->get()->double(); // 1.1

str() - to string

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler('1.1');
$data->get()->str(); // '1.1'

bool() - to boolean

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler('1.1');
$data->get()->bool(); // true

array() - to array

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler([1.1]);
$data->get()->array(); // [1.1]

object() - to object

use LanguageSpecific\ArrayHandler;
use LanguageSpecific\ValueHandler;

$data = new ArrayHandler(new ValueHandler());
$value = $data->get()->object();
var_export($value,true);
/*
LanguageSpecific\ValueHandler::__set_state(array(
   '_value' => NULL,
   '_has' => true,
   '_default' => NULL,
))
*/

has() - flag that value of element was defined on exemplar construction

use LanguageSpecific\ArrayHandler;

$data = new ArrayHandler([0=>1]);
$data->get(0)->has(); // true
// array element with index 0 has value

$data = new ArrayHandler([2=>3]);
$data->get('4')->has(); // false
// array element with index '4' not has value

type() - get type of value

use LanguageSpecific\ValueHandler;

(new ValueHandler(null))->type(); // `NULL`

(new ValueHandler(false))->type(); // `boolean`

(new ValueHandler(0))->type(); // `integer`

(new ValueHandler(0.0))->type(); // `double`

(new ValueHandler('a'))->type(); // `string`

(new ValueHandler([]))->type(); // `array`

(new ValueHandler(new ValueHandler()))->type(); // `object`

asUndefined() - value handler with undefined value

use LanguageSpecific\ValueHandler;

$value = ValueHandler::asUndefined();
var_export($value,true);
/*
LanguageSpecific\ValueHandler::__set_state(array(
   '_value' => NULL,
   '_has' => false,
   '_default' => NULL,
))
*/

default($value = null) - define default value that will be used with undefined value

use LanguageSpecific\ValueHandler;

ValueHandler::asUndefined()->default('default')->str(); // 'default'
(new ValueHandler('string'))->default('default')->str(); // 'string'

Detail info

Refer to

• Array Handler
• Value Handler

for detail examples of class methods working

Unit tests

composer test

Контакты

Вольхин Николай
e-mail [e-mail]
phone [phone]
Telegram @sbwerewolf

Telegram chat with me