Helpers

Introduction

LaraGram includes a variety of global "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.

Available Methods

Arrays & Objects

Numbers

Paths

app_path base_path config_path database_path lang_path public_path template_path storage_path

URLs

action listen to_listen

Miscellaneous

Arrays & Objects

`Arr::accessible()`

The Arr::accessible method determines if the given value is array accessible:

php

use LaraGram\Support\Arr;
use LaraGram\Support\Collection;

$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);

// true

$isAccessible = Arr::accessible(new Collection);

// true

$isAccessible = Arr::accessible('abc');

// false

$isAccessible = Arr::accessible(new stdClass);

// false

`Arr::add()`

The Arr::add method adds a given key / value pair to an array if the given key doesn't already exist in the array or is set to null:

php

use LaraGram\Support\Arr;

$array = Arr::add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

`Arr::array()`

The Arr::array method retrieves a value from a deeply nested array using "dot" notation (just as Arr::get() does), but throws an InvalidArgumentException if the requested value is not an array:

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$value = Arr::array($array, 'languages');

// ['PHP', 'Ruby']

$value = Arr::array($array, 'name');

// throws InvalidArgumentException

`Arr::boolean()`

The Arr::boolean method retrieves a value from a deeply nested array using "dot" notation (just as Arr::get() does), but throws an InvalidArgumentException if the requested value is not a boolean:

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'available' => true];

$value = Arr::boolean($array, 'available');

// true

$value = Arr::boolean($array, 'name');

// throws InvalidArgumentException

`Arr::collapse()`

The Arr::collapse method collapses an array of arrays or collections into a single array:

php

use LaraGram\Support\Arr;

$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

`Arr::crossJoin()`

The Arr::crossJoin method cross joins the given arrays, returning a Cartesian product with all possible permutations:

php

use LaraGram\Support\Arr;

$matrix = Arr::crossJoin([1, 2], ['a', 'b']);

/*
    [
        [1, 'a'],
        [1, 'b'],
        [2, 'a'],
        [2, 'b'],
    ]
*/

$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);

/*
    [
        [1, 'a', 'I'],
        [1, 'a', 'II'],
        [1, 'b', 'I'],
        [1, 'b', 'II'],
        [2, 'a', 'I'],
        [2, 'a', 'II'],
        [2, 'b', 'I'],
        [2, 'b', 'II'],
    ]
*/

`Arr::divide()`

The Arr::divide method returns two arrays: one containing the keys and the other containing the values of the given array:

php

use LaraGram\Support\Arr;

[$keys, $values] = Arr::divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

The Arr::dot method flattens a multi-dimensional array into a single level array that uses "dot" notation to indicate depth:

php

use LaraGram\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$flattened = Arr::dot($array);

// ['products.desk.price' => 100]

`Arr::except()`

The Arr::except method removes the given key / value pairs from an array:

php

use LaraGram\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$filtered = Arr::except($array, ['price']);

// ['name' => 'Desk']

`Arr::exists()`

The Arr::exists method checks that the given key exists in the provided array:

php

use LaraGram\Support\Arr;

$array = ['name' => 'John Doe', 'age' => 17];

$exists = Arr::exists($array, 'name');

// true

$exists = Arr::exists($array, 'salary');

// false

`Arr::first()`

The Arr::first method returns the first element of an array passing a given truth test:

php

use LaraGram\Support\Arr;

$array = [100, 200, 300];

$first = Arr::first($array, function (int $value, int $key) {
    return $value >= 150;
});

// 200

A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:

php

use LaraGram\Support\Arr;

$first = Arr::first($array, $callback, $default);

`Arr::flatten()`

The Arr::flatten method flattens a multi-dimensional array into a single level array:

php

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$flattened = Arr::flatten($array);

// ['Joe', 'PHP', 'Ruby']

`Arr::float()`

The Arr::float method retrieves a value from a deeply nested array using "dot" notation (just as Arr::get() does), but throws an InvalidArgumentException if the requested value is not a float:

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'balance' => 123.45];

$value = Arr::float($array, 'balance');

// 123.45

$value = Arr::float($array, 'name');

// throws InvalidArgumentException

`Arr::forget()`

The Arr::forget method removes a given key / value pairs from a deeply nested array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::forget($array, 'products.desk');

// ['products' => []]

`Arr::from()`

The Arr::from method converts various input types into a plain PHP array. It supports a range of input types, including arrays, objects, and several common LaraGram interfaces, such as Arrayable, Enumerable, Jsonable, and JsonSerializable. Additionally, it handles Traversable and WeakMap instances:

php

use LaraGram\Support\Arr;

Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']

class TestJsonableObject implements Jsonable
{
    public function toJson($options = 0)
    {
        return json_encode(['foo' => 'bar']);
    }
}

Arr::from(new TestJsonableObject); // ['foo' => 'bar']

`Arr::get()`

The Arr::get method retrieves a value from a deeply nested array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$price = Arr::get($array, 'products.desk.price');

// 100

The Arr::get method also accepts a default value, which will be returned if the specified key is not present in the array:

php

use LaraGram\Support\Arr;

$discount = Arr::get($array, 'products.desk.discount', 0);

// 0

`Arr::has()`

The Arr::has method checks whether a given item or items exists in an array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::has($array, 'product.name');

// true

$contains = Arr::has($array, ['product.price', 'product.discount']);

// false

`Arr::hasAll()`

The Arr::hasAll method determines if all of the specified keys exist in the given array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['name' => 'Taylor', 'language' => 'PHP'];

Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // false

`Arr::hasAny()`

The Arr::hasAny method checks whether any item in a given set exists in an array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::hasAny($array, 'product.name');

// true

$contains = Arr::hasAny($array, ['product.name', 'product.discount']);

// true

$contains = Arr::hasAny($array, ['category', 'product.discount']);

// false

`Arr::integer()`

The Arr::integer method retrieves a value from a deeply nested array using "dot" notation (just as Arr::get() does), but throws an InvalidArgumentException if the requested value is not an int:

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'age' => 42];

$value = Arr::integer($array, 'age');

// 42

$value = Arr::integer($array, 'name');

// throws InvalidArgumentException

`Arr::isAssoc()`

The Arr::isAssoc method returns true if the given array is an associative array. An array is considered "associative" if it doesn't have sequential numerical keys beginning with zero:

php

use LaraGram\Support\Arr;

$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);

// true

$isAssoc = Arr::isAssoc([1, 2, 3]);

// false

`Arr::isList()`

The Arr::isList method returns true if the given array's keys are sequential integers beginning from zero:

php

use LaraGram\Support\Arr;

$isList = Arr::isList(['foo', 'bar', 'baz']);

// true

$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);

// false

`Arr::join()`

The Arr::join method joins array elements with a string. Using this method's third argument, you may also specify the joining string for the final element of the array:

php

use LaraGram\Support\Arr;

$array = ['Tailwind', 'Alpine', 'LaraGram', 'Livewire'];

$joined = Arr::join($array, ', ');

// Tailwind, Alpine, LaraGram, Livewire

$joined = Arr::join($array, ', ', ', and ');

// Tailwind, Alpine, LaraGram, and Livewire

`Arr::keyBy()`

The Arr::keyBy method keys the array by the given key. If multiple items have the same key, only the last one will appear in the new array:

php

use LaraGram\Support\Arr;

$array = [
    ['product_id' => 'prod-100', 'name' => 'Desk'],
    ['product_id' => 'prod-200', 'name' => 'Chair'],
];

$keyed = Arr::keyBy($array, 'product_id');

/*
    [
        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
    ]
*/

`Arr::last()`

The Arr::last method returns the last element of an array passing a given truth test:

php

use LaraGram\Support\Arr;

$array = [100, 200, 300, 110];

$last = Arr::last($array, function (int $value, int $key) {
    return $value >= 150;
});

// 300

A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:

php

use LaraGram\Support\Arr;

$last = Arr::last($array, $callback, $default);

`Arr::map()`

The Arr::map method iterates through the array and passes each value and key to the given callback. The array value is replaced by the value returned by the callback:

php

use LaraGram\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

`Arr::mapSpread()`

The Arr::mapSpread method iterates over the array, passing each nested item value into the given closure. The closure is free to modify the item and return it, thus forming a new array of modified items:

php

use LaraGram\Support\Arr;

$array = [
    [0, 1],
    [2, 3],
    [4, 5],
    [6, 7],
    [8, 9],
];

$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
    return $even + $odd;
});

/*
    [1, 5, 9, 13, 17]
*/

`Arr::mapWithKeys()`

The Arr::mapWithKeys method iterates through the array and passes each value to the given callback. The callback should return an associative array containing a single key / value pair:

php

use LaraGram\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => 'john@example.com',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => 'jane@example.com',
    ]
];

$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});

/*
    [
        'john@example.com' => 'John',
        'jane@example.com' => 'Jane',
    ]
*/

`Arr::only()`

The Arr::only method returns only the specified key / value pairs from the given array:

php

use LaraGram\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$slice = Arr::only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

`Arr::partition()`

The Arr::partition method may be combined with PHP array destructuring to separate elements that pass a given truth test from those that do not:

php

<?php

use LaraGram\Support\Arr;

$numbers = [1, 2, 3, 4, 5, 6];

[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
    return $i < 3;
});

dump($underThree);

// [1, 2]

dump($equalOrAboveThree);

// [3, 4, 5, 6]

`Arr::pluck()`

The Arr::pluck method retrieves all of the values for a given key from an array:

php

use LaraGram\Support\Arr;

$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];

$names = Arr::pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

You may also specify how you wish the resulting list to be keyed:

php

use LaraGram\Support\Arr;

$names = Arr::pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail']

`Arr::prepend()`

The Arr::prepend method will push an item onto the beginning of an array:

php

use LaraGram\Support\Arr;

$array = ['one', 'two', 'three', 'four'];

$array = Arr::prepend($array, 'zero');

// ['zero', 'one', 'two', 'three', 'four']

If needed, you may specify the key that should be used for the value:

php

use LaraGram\Support\Arr;

$array = ['price' => 100];

$array = Arr::prepend($array, 'Desk', 'name');

// ['name' => 'Desk', 'price' => 100]

`Arr::prependKeysWith()`

The Arr::prependKeysWith prepends all key names of an associative array with the given prefix:

php

use LaraGram\Support\Arr;

$array = [
    'name' => 'Desk',
    'price' => 100,
];

$keyed = Arr::prependKeysWith($array, 'product.');

/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

`Arr::pull()`

The Arr::pull method returns and removes a key / value pair from an array:

php

use LaraGram\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$name = Arr::pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:

php

use LaraGram\Support\Arr;

$value = Arr::pull($array, $key, $default);

`Arr::query()`

The Arr::query method converts the array into a query string:

php

use LaraGram\Support\Arr;

$array = [
    'name' => 'Taylor',
    'order' => [
        'column' => 'created_at',
        'direction' => 'desc'
    ]
];

Arr::query($array);

// name=Taylor&order[column]=created_at&order[direction]=desc

`Arr::random()`

The Arr::random method returns a random value from an array:

php

use LaraGram\Support\Arr;

$array = [1, 2, 3, 4, 5];

$random = Arr::random($array);

// 4 - (retrieved randomly)

You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array even if only one item is desired:

php

use LaraGram\Support\Arr;

$items = Arr::random($array, 2);

// [2, 5] - (retrieved randomly)

`Arr::reject()`

The Arr::reject method removes items from an array using the given closure:

php

use LaraGram\Support\Arr;

$array = [100, '200', 300, '400', 500];

$filtered = Arr::reject($array, function (string|int $value, int $key) {
    return is_string($value);
});

// [0 => 100, 2 => 300, 4 => 500]

`Arr::select()`

The Arr::select method selects an array of values from an array:

php

use LaraGram\Support\Arr;

$array = [
    ['id' => 1, 'name' => 'Desk', 'price' => 200],
    ['id' => 2, 'name' => 'Table', 'price' => 150],
    ['id' => 3, 'name' => 'Chair', 'price' => 300],
];

Arr::select($array, ['name', 'price']);

// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]

`Arr::set()`

The Arr::set method sets a value within a deeply nested array using "dot" notation:

php

use LaraGram\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

`Arr::shuffle()`

The Arr::shuffle method randomly shuffles the items in the array:

php

use LaraGram\Support\Arr;

$array = Arr::shuffle([1, 2, 3, 4, 5]);

// [3, 2, 5, 1, 4] - (generated randomly)

`Arr::sole()`

The Arr::sole method retrieves a single value from an array using the given closure. If more than one value within the array matches the given truth test, an LaraGram\Support\MultipleItemsFoundException exception will be thrown. If no values match the truth test, an LaraGram\Support\ItemNotFoundException exception will be thrown:

php

use LaraGram\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$value = Arr::sole($array, fn (string $value) => $value === 'Desk');

// 'Desk'

`Arr::sort()`

The Arr::sort method sorts an array by its values:

php

use LaraGram\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sort($array);

// ['Chair', 'Desk', 'Table']

You may also sort the array by the results of a given closure:

php

use LaraGram\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sort($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

`Arr::sortDesc()`

The Arr::sortDesc method sorts an array in descending order by its values:

php

use LaraGram\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sortDesc($array);

// ['Table', 'Desk', 'Chair']

You may also sort the array by the results of a given closure:

php

use LaraGram\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sortDesc($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Table'],
        ['name' => 'Desk'],
        ['name' => 'Chair'],
    ]
*/

`Arr::sortRecursive()`

The Arr::sortRecursive method recursively sorts an array using the sort function for numerically indexed sub-arrays and the ksort function for associative sub-arrays:

php

use LaraGram\Support\Arr;

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

$sorted = Arr::sortRecursive($array);

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

If you would like the results sorted in descending order, you may use the Arr::sortRecursiveDesc method.

php

$sorted = Arr::sortRecursiveDesc($array);

`Arr::string()`

The Arr::string method retrieves a value from a deeply nested array using "dot" notation (just as Arr::get() does), but throws an InvalidArgumentException if the requested value is not a string:

use LaraGram\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$value = Arr::string($array, 'name');

// Joe

$value = Arr::string($array, 'languages');

// throws InvalidArgumentException

`Arr::take()`

The Arr::take method returns a new array with the specified number of items:

php

use LaraGram\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]

You may also pass a negative integer to take the specified number of items from the end of the array:

php

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, -2);

// [4, 5]

`Arr::toCssClasses()`

The Arr::toCssClasses method conditionally compiles a CSS class string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

php

use LaraGram\Support\Arr;

$isActive = false;
$hasError = true;

$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];

$classes = Arr::toCssClasses($array);

/*
    'p-4 bg-red'
*/

`Arr::toCssStyles()`

The Arr::toCssStyles conditionally compiles a CSS style string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

php

use LaraGram\Support\Arr;

$hasColor = true;

$array = ['background-color: blue', 'color: blue' => $hasColor];

$classes = Arr::toCssStyles($array);

/*
    'background-color: blue; color: blue;'
*/

This method powers LaraGram's functionality allowing merging classes with a Blade component's attribute bag as well as the @class Blade directive.

`Arr::undot()`

The Arr::undot method expands a single-dimensional array that uses "dot" notation into a multi-dimensional array:

php

use LaraGram\Support\Arr;

$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];

$array = Arr::undot($array);

// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

`Arr::where()`

The Arr::where method filters an array using the given closure:

php

use LaraGram\Support\Arr;

$array = [100, '200', 300, '400', 500];

$filtered = Arr::where($array, function (string|int $value, int $key) {
    return is_string($value);
});

// [1 => '200', 3 => '400']

`Arr::whereNotNull()`

The Arr::whereNotNull method removes all null values from the given array:

php

use LaraGram\Support\Arr;

$array = [0, null];

$filtered = Arr::whereNotNull($array);

// [0 => 0]

`Arr::wrap()`

The Arr::wrap method wraps the given value in an array. If the given value is already an array it will be returned without modification:

php

use LaraGram\Support\Arr;

$string = 'LaraGram';

$array = Arr::wrap($string);

// ['LaraGram']

If the given value is null, an empty array will be returned:

php

use LaraGram\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

The data_fill function sets a missing value within a nested array or object using "dot" notation:

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_fill($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 100]]]

data_fill($data, 'products.desk.discount', 10);

// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

This function also accepts asterisks as wildcards and will fill the target accordingly:

php

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2'],
    ],
];

data_fill($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 100],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

`data_get()`

The data_get function retrieves a value from a nested array or object using "dot" notation:

php

$data = ['products' => ['desk' => ['price' => 100]]];

$price = data_get($data, 'products.desk.price');

// 100

The data_get function also accepts a default value, which will be returned if the specified key is not found:

php

$discount = data_get($data, 'products.desk.discount', 0);

// 0

The function also accepts wildcards using asterisks, which may target any key of the array or object:

php

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];

data_get($data, '*.name');

// ['Desk 1', 'Desk 2'];

The {first} and {last} placeholders may be used to retrieve the first or last items in an array:

php

$flight = [
    'segments' => [
        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
    ],
];

data_get($flight, 'segments.{first}.arrival');

// 15:00

`data_set()`

The data_set function sets a value within a nested array or object using "dot" notation:

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

This function also accepts wildcards using asterisks and will set values on the target accordingly:

php

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_set($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 200],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

By default, any existing values are overwritten. If you wish to only set a value if it doesn't exist, you may pass false as the fourth argument to the function:

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200, overwrite: false);

// ['products' => ['desk' => ['price' => 100]]]

`data_forget()`

The data_forget function removes a value within a nested array or object using "dot" notation:

php

$data = ['products' => ['desk' => ['price' => 100]]];

data_forget($data, 'products.desk.price');

// ['products' => ['desk' => []]]

This function also accepts wildcards using asterisks and will remove values on the target accordingly:

php

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_forget($data, 'products.*.price');

/*
    [
        'products' => [
            ['name' => 'Desk 1'],
            ['name' => 'Desk 2'],
        ],
    ]
*/

`head()`

The head function returns the first element in the given array. If the array is empty, false will be returned:

php

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

The last function returns the last element in the given array. If the array is empty, false will be returned:

php

$array = [100, 200, 300];

$last = last($array);

// 300

Numbers

`Number::abbreviate()`

The Number::abbreviate method returns the human-readable format of the provided numerical value, with an abbreviation for the units:

php

use LaraGram\Support\Number;

$number = Number::abbreviate(1000);

// 1K

$number = Number::abbreviate(489939);

// 490K

$number = Number::abbreviate(1230000, precision: 2);

// 1.23M

`Number::clamp()`

The Number::clamp method ensures a given number stays within a specified range. If the number is lower than the minimum, the minimum value is returned. If the number is higher than the maximum, the maximum value is returned:

php

use LaraGram\Support\Number;

$number = Number::clamp(105, min: 10, max: 100);

// 100

$number = Number::clamp(5, min: 10, max: 100);

// 10

$number = Number::clamp(10, min: 10, max: 100);

// 10

$number = Number::clamp(20, min: 10, max: 100);

// 20

`Number::currency()`

The Number::currency method returns the currency representation of the given value as a string:

php

use LaraGram\Support\Number;

$currency = Number::currency(1000);

// $1,000.00

$currency = Number::currency(1000, in: 'EUR');

// €1,000.00

$currency = Number::currency(1000, in: 'EUR', locale: 'de');

// 1.000,00 €

$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);

// 1.000 €

`Number::defaultCurrency()`

The Number::defaultCurrency method returns the default currency being used by the Number class:

php

use LaraGram\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

The Number::defaultLocale method returns the default locale being used by the Number class:

php

use LaraGram\Support\Number;

$locale = Number::defaultLocale();

// en

`Number::fileSize()`

The Number::fileSize method returns the file size representation of the given byte value as a string:

php

use LaraGram\Support\Number;

$size = Number::fileSize(1024);

// 1 KB

$size = Number::fileSize(1024 * 1024);

// 1 MB

$size = Number::fileSize(1024, precision: 2);

// 1.00 KB

`Number::forHumans()`

The Number::forHumans method returns the human-readable format of the provided numerical value:

php

use LaraGram\Support\Number;

$number = Number::forHumans(1000);

// 1 thousand

$number = Number::forHumans(489939);

// 490 thousand

$number = Number::forHumans(1230000, precision: 2);

// 1.23 million

`Number::format()`

The Number::format method formats the given number into a locale specific string:

php

use LaraGram\Support\Number;

$number = Number::format(100000);

// 100,000

$number = Number::format(100000, precision: 2);

// 100,000.00

$number = Number::format(100000.123, maxPrecision: 2);

// 100,000.12

$number = Number::format(100000, locale: 'de');

// 100.000

`Number::ordinal()`

The Number::ordinal method returns a number's ordinal representation:

php

use LaraGram\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::pairs()`

The Number::pairs method generates an array of number pairs (sub-ranges) based on a specified range and step value. This method can be useful for dividing a larger range of numbers into smaller, manageable sub-ranges for things like pagination or batching tasks. The pairs method returns an array of arrays, where each inner array represents a pair (sub-range) of numbers:

php

use LaraGram\Support\Number;

$result = Number::pairs(25, 10);

// [[0, 9], [10, 19], [20, 25]]

$result = Number::pairs(25, 10, offset: 0);

// [[0, 10], [10, 20], [20, 25]]

`Number::parseInt()`

The Number::parseInt method parse a string into an integer according to the specified locale:

php

use LaraGram\Support\Number;

$result = Number::parseInt('10.123');

// (int) 10

$result = Number::parseInt('10,123', locale: 'fr');

// (int) 10

`Number::parseFloat()`

The Number::parseFloat method parse a string into a float according to the specified locale:

php

use LaraGram\Support\Number;

$result = Number::parseFloat('10');

// (float) 10.0

$result = Number::parseFloat('10', locale: 'fr');

// (float) 10.0

`Number::percentage()`

The Number::percentage method returns the percentage representation of the given value as a string:

php

use LaraGram\Support\Number;

$percentage = Number::percentage(10);

// 10%

$percentage = Number::percentage(10, precision: 2);

// 10.00%

$percentage = Number::percentage(10.123, maxPrecision: 2);

// 10.12%

$percentage = Number::percentage(10, precision: 2, locale: 'de');

// 10,00%

`Number::spell()`

The Number::spell method transforms the given number into a string of words:

php

use LaraGram\Support\Number;

$number = Number::spell(102);

// one hundred and two

$number = Number::spell(88, locale: 'fr');

// quatre-vingt-huit

The after argument allows you to specify a value after which all numbers should be spelled out:

php

$number = Number::spell(10, after: 10);

// 10

$number = Number::spell(11, after: 10);

// eleven

The until argument allows you to specify a value before which all numbers should be spelled out:

php

$number = Number::spell(5, until: 10);

// five

$number = Number::spell(10, until: 10);

// 10

`Number::spellOrdinal()`

The Number::spellOrdinal method returns the number's ordinal representation as a string of words:

php

use LaraGram\Support\Number;

$number = Number::spellOrdinal(1);

// first

$number = Number::spellOrdinal(2);

// second

$number = Number::spellOrdinal(21);

// twenty-first

`Number::trim()`

The Number::trim method removes any trailing zero digits after the decimal point of the given number:

php

use LaraGram\Support\Number;

$number = Number::trim(12.0);

// 12

$number = Number::trim(12.30);

// 12.3

`Number::useLocale()`

The Number::useLocale method sets the default number locale globally, which affects how numbers and currency are formatted by subsequent invocations to the Number class's methods:

php

use LaraGram\Support\Number;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useLocale('de');
}

`Number::withLocale()`

The Number::withLocale method executes the given closure using the specified locale and then restores the original locale after the callback has executed:

php

use LaraGram\Support\Number;

$number = Number::withLocale('de', function () {
    return Number::format(1500);
});

`Number::useCurrency()`

The Number::useCurrency method sets the default number currency globally, which affects how the currency is formatted by subsequent invocations to the Number class's methods:

php

use LaraGram\Support\Number;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useCurrency('GBP');
}

`Number::withCurrency()`

The Number::withCurrency method executes the given closure using the specified currency and then restores the original currency after the callback has executed:

php

use LaraGram\Support\Number;

$number = Number::withCurrency('GBP', function () {
    // ...
});

Paths

`app_path()`

The app_path function returns the fully qualified path to your application's app directory. You may also use the app_path function to generate a fully qualified path to a file relative to the application directory:

php

$path = app_path();

$path = app_path('Http/Controllers/Controller.php');

`base_path()`

The base_path function returns the fully qualified path to your application's root directory. You may also use the base_path function to generate a fully qualified path to a given file relative to the project root directory:

php

$path = base_path();

$path = base_path('vendor/bin');

`config_path()`

The config_path function returns the fully qualified path to your application's config directory. You may also use the config_path function to generate a fully qualified path to a given file within the application's configuration directory:

php

$path = config_path();

$path = config_path('app.php');

`database_path()`

The database_path function returns the fully qualified path to your application's database directory. You may also use the database_path function to generate a fully qualified path to a given file within the database directory:

php

$path = database_path();

$path = database_path('factories/UserFactory.php');

`lang_path()`

The lang_path function returns the fully qualified path to your application's lang directory. You may also use the lang_path function to generate a fully qualified path to a given file within the directory:

php

$path = lang_path();

$path = lang_path('en/messages.php');

NOTE

By default, the LaraGram application skeleton does not include the lang directory. If you would like to customize LaraGram's language files, you may publish them via the lang:publish Commander command.

`public_path()`

The public_path function returns the fully qualified path to your application's public directory. You may also use the public_path function to generate a fully qualified path to a given file within the public directory:

php

$path = public_path();

$path = public_path('css/app.css');

`template_path()`

The template_path function returns the fully qualified path to your application's templates directory. You may also use the template_path function to generate a fully qualified path to a given file within the templates directory:

php

$path = template_path();

$path = template_path('panel/admin.t8.php');

`storage_path()`

The storage_path function returns the fully qualified path to your application's storage directory. You may also use the storage_path function to generate a fully qualified path to a given file within the storage directory:

php

$path = storage_path();

$path = storage_path('app/file.txt');

URLs

`action()`

The action function generates a URL for the given controller action:

php

use App\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

If the method accepts listen parameters, you may pass them as the second argument to the method:

php

$url = action([UserController::class, 'profile'], ['id' => 1]);

`listen()`

The listen function generates a URL for a given named listen:

php

$url = listen('listen.name');

If the listen accepts parameters, you may pass them as the second argument to the function:

php

$url = listen('listen.name', ['id' => 1]);

`to_listen()`

The to_listen function generates a redirect for a given named listen:

php

return to_listen('users.show', ['user' => 1]);

Miscellaneous

`app()`

The app function returns the service container instance:

php

$container = app();

You may pass a class or interface name to resolve it from the container:

php

$api = app('HelpSpot\API');

`auth()`

The auth function returns an authenticator instance. You may use it as an alternative to the Auth facade:

php

$user = auth()->user();

If needed, you may specify which guard instance you would like to access:

php

$user = auth('admin')->user();

`bcrypt()`

The bcrypt function hashes the given value using Bcrypt. You may use this function as an alternative to the Hash facade:

php

$password = bcrypt('my-secret-password');

`blank()`

The blank function determines whether the given value is "blank":

php

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

For the inverse of blank, see the filled function.

`cache()`

The cache function may be used to get values from the cache. If the given key does not exist in the cache, an optional default value will be returned:

php

$value = cache('key');

$value = cache('key', 'default');

You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of seconds or duration the cached value should be considered valid:

php

cache(['key' => 'value'], 300);

cache(['key' => 'value'], now()->addSeconds(10));

`class_uses_recursive()`

The class_uses_recursive function returns all traits used by a class, including traits used by all of its parent classes:

php

$traits = class_uses_recursive(App\Models\User::class);

`collect()`

The collect function creates a collection instance from the given value:

php

$collection = collect(['Taylor', 'Abigail']);

`config()`

The config function gets the value of a configuration variable. The configuration values may be accessed using "dot" syntax, which includes the name of the file and the option you wish to access. You may also provide a default value that will be returned if the configuration option does not exist:

php

$value = config('app.timezone');

$value = config('app.timezone', $default);

You may set configuration variables at runtime by passing an array of key / value pairs. However, note that this function only affects the configuration value for the current request and does not update your actual configuration values:

php

config(['app.debug' => true]);

`context()`

The context function gets the value from the current context. You may also provide a default value that will be returned if the context key does not exist:

php

$value = context('trace_id');

$value = context('trace_id', $default);

You may set context values by passing an array of key / value pairs:

php

use LaraGram\Support\Str;

context(['trace_id' => Str::uuid()->toString()]);

`decrypt()`

The decrypt function decrypts the given value. You may use this function as an alternative to the Crypt facade:

php

$password = decrypt($value);

For the inverse of decrypt, see the encrypt function.

`dispatch()`

The dispatch function pushes the given job onto the LaraGram job queue:

php

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

The dispatch_sync function pushes the given job to the sync queue so that it is processed immediately:

php

dispatch_sync(new App\Jobs\SendEmails);

If you want to stop executing the script after dumping the variables, use the dd function instead.

`encrypt()`

The encrypt function encrypts the given value. You may use this function as an alternative to the Crypt facade:

php

$secret = encrypt('my-secret-value');

For the inverse of encrypt, see the decrypt function.

`env()`

The env function retrieves the value of an environment variable or returns a default value:

php

$env = env('APP_ENV');

$env = env('APP_ENV', 'production');

WARNING

If you execute the config:cache command during your deployment process, you should be sure that you are only calling the env function from within your configuration files. Once the configuration has been cached, the .env file will not be loaded and all calls to the env function will return external environment variables such as server-level or system-level environment variables or null.

`event()`

The event function dispatches the given event to its listeners:

php

event(new UserRegistered($user));

`filled()`

The filled function determines whether the given value is not "blank":

php

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

For the inverse of filled, see the blank function.

`info()`

The info function will write information to your application's log:

php

info('Some helpful information!');

An array of contextual data may also be passed to the function:

php

info('User login attempt failed.', ['id' => $user->id]);

`literal()`

The literal function creates a new stdClass instance with the given named arguments as properties:

php

$obj = literal(
    name: 'Joe',
    languages: ['PHP', 'Ruby'],
);

$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']

`logger()`

The logger function can be used to write a debug level message to the log:

php

logger('Debug message');

An array of contextual data may also be passed to the function:

php

logger('User has logged in.', ['id' => $user->id]);

A logger instance will be returned if no value is passed to the function:

php

logger()->error('You are not allowed here.');

`now()`

The now function creates a new LaraGram\Support\Tempora instance for the current time:

php

$now = now();

`once()`

The once function executes the given callback and caches the result in memory for the duration of the request. Any subsequent calls to the once function with the same callback will return the previously cached result:

php

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}

random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)

When the once function is executed from within an object instance, the cached result will be unique to that object instance:

php

<?php

class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}

$service = new NumberService;

$service->all();
$service->all(); // (cached result)

$secondService = new NumberService;

$secondService->all();
$secondService->all(); // (cached result)

`optional()`

The optional function accepts any argument and allows you to access properties or call methods on that object. If the given object is null, properties and methods will return null instead of causing an error:

php

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

The optional function also accepts a closure as its second argument. The closure will be invoked if the value provided as the first argument is not null:

php

return optional(User::find($id), function (User $user) {
    return $user->name;
});

`policy()`

The policy method retrieves a policy instance for a given class:

php

$policy = policy(App\Models\User::class);

`redirect()`

The redirect function returns a redirect, or returns the redirector instance if called with no arguments:

php

return redirect();

return redirect()->listen('listen.name');

`report()`

The report function will report an exception using your exception handler:

php

report($e);

The report function also accepts a string as an argument. When a string is given to the function, the function will create an exception with the given string as its message:

php

report('Something went wrong.');

`report_if()`

The report_if function will report an exception using your exception handler if a given boolean expression evaluates to true:

php

report_if($shouldReport, $e);

report_if($shouldReport, 'Something went wrong.');

`report_unless()`

The report_unless function will report an exception using your exception handler if a given boolean expression evaluates to false:

php

report_unless($reportingDisabled, $e);

report_unless($reportingDisabled, 'Something went wrong.');

`request()`

The request function returns the current request instance or obtains an input field's value from the current request:

php

$request = request();

$value = request('key', $default);

`rescue()`

The rescue function executes the given closure and catches any exceptions that occur during its execution. All exceptions that are caught will be sent to your exception handler; however, the request will continue processing:

php

return rescue(function () {
    return $this->method();
});

You may also pass a second argument to the rescue function. This argument will be the "default" value that should be returned if an exception occurs while executing the closure:

php

return rescue(function () {
    return $this->method();
}, false);

return rescue(function () {
    return $this->method();
}, function () {
    return $this->failure();
});

A report argument may be provided to the rescue function to determine if the exception should be reported via the report function:

php

return rescue(function () {
    return $this->method();
}, report: function (Throwable $throwable) {
    return $throwable instanceof InvalidArgumentException;
});

`resolve()`

The resolve function resolves a given class or interface name to an instance using the service container:

php

$api = resolve('HelpSpot\API');

`retry()`

The retry function attempts to execute the given callback until the given maximum attempt threshold is met. If the callback does not throw an exception, its return value will be returned. If the callback throws an exception, it will automatically be retried. If the maximum attempt count is exceeded, the exception will be thrown:

php

return retry(5, function () {
    // Attempt 5 times while resting 100ms between attempts...
}, 100);

If you would like to manually calculate the number of milliseconds to sleep between attempts, you may pass a closure as the third argument to the retry function:

php

use Exception;

return retry(5, function () {
    // ...
}, function (int $attempt, Exception $exception) {
    return $attempt * 100;
});

For convenience, you may provide an array as the first argument to the retry function. This array will be used to determine how many milliseconds to sleep between subsequent attempts:

php

return retry([100, 200], function () {
    // Sleep for 100ms on first retry, 200ms on second retry...
});

To only retry under specific conditions, you may pass a closure as the fourth argument to the retry function:

php

use App\Exceptions\TemporaryException;
use Exception;

return retry(5, function () {
    // ...
}, 100, function (Exception $exception) {
    return $exception instanceof TemporaryException;
});

`tap()`

The tap function accepts two arguments: an arbitrary $value and a closure. The $value will be passed to the closure and then be returned by the tap function. The return value of the closure is irrelevant:

php

$user = tap(User::first(), function (User $user) {
    $user->name = 'Taylor';

    $user->save();
});

If no closure is passed to the tap function, you may call any method on the given $value. The return value of the method you call will always be $value, regardless of what the method actually returns in its definition. For example, the Eloquent update method typically returns an integer. However, we can force the method to return the model itself by chaining the update method call through the tap function:

php

$user = tap($user)->update([
    'name' => $name,
    'email' => $email,
]);

To add a tap method to a class, you may add the LaraGram\Support\Traits\Tappable trait to the class. The tap method of this trait accepts a Closure as its only argument. The object instance itself will be passed to the Closure and then be returned by the tap method:

php

return $user->tap(function (User $user) {
    // ...
});

`template()`

The template function retrieves a view instance:

php

return template('panel.admin');

`throw_if()`

The throw_if function throws the given exception if a given boolean expression evaluates to true:

php

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`throw_unless()`

The throw_unless function throws the given exception if a given boolean expression evaluates to false:

php

throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`today()`

The today function creates a new LaraGram\Support\Carbon instance for the current date:

php

$today = today();

`trait_uses_recursive()`

The trait_uses_recursive function returns all traits used by a trait:

php

$traits = trait_uses_recursive(\LaraGram\Notifications\Notifiable::class);

`transform()`

The transform function executes a closure on a given value if the value is not blank and then returns the return value of the closure:

php

$callback = function (int $value) {
    return $value * 2;
};

$result = transform(5, $callback);

// 10

A default value or closure may be passed as the third argument to the function. This value will be returned if the given value is blank:

php

$result = transform(null, $callback, 'The value is blank');

// The value is blank

`validator()`

The validator function creates a new validator instance with the given arguments. You may use it as an alternative to the Validator facade:

php

$validator = validator($data, $rules, $messages);

`value()`

The value function returns the value it is given. However, if you pass a closure to the function, the closure will be executed and its returned value will be returned:

php

$result = value(true);

// true

$result = value(function () {
    return false;
});

// false

Additional arguments may be passed to the value function. If the first argument is a closure then the additional parameters will be passed to the closure as arguments, otherwise they will be ignored:

php

$result = value(function (string $name) {
    return $name;
}, 'Taylor');

// 'Taylor'

`with()`

The with function returns the value it is given. If a closure is passed as the second argument to the function, the closure will be executed and its returned value will be returned:

php

$callback = function (mixed $value) {
    return is_numeric($value) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5

`when()`

The when function returns the value it is given if a given condition evaluates to true. Otherwise, null is returned. If a closure is passed as the second argument to the function, the closure will be executed and its returned value will be returned:

php

$value = when(true, 'Hello World');

$value = when(true, fn () => 'Hello World');

The when function is primarily useful for conditionally rendering HTML attributes:

blade

<div {!! when($condition, 'wire:poll="calculate"') !!}>
    ...
</div>

Other Utilities

Benchmarking

Sometimes you may wish to quickly test the performance of certain parts of your application. On those occasions, you may utilize the Benchmark support class to measure the number of milliseconds it takes for the given callbacks to complete:

php

<?php

use App\Models\User;
use LaraGram\Support\Benchmark;

Benchmark::mesure(fn () => User::find(1)); // 0.1 ms

Benchmark::mesure([
    'Scenario 1' => fn () => User::count(), // 0.5 ms
    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);

By default, the given callbacks will be executed once (one iteration), and their duration will be displayed in the browser / console.

To invoke a callback more than once, you may specify the number of iterations that the callback should be invoked as the second argument to the method. When executing a callback more than once, the Benchmark class will return the average number of milliseconds it took to execute the callback across all iterations:

php

Benchmark::mesure(fn () => User::count(), iterations: 10); // 0.5 ms

Sometimes, you may want to benchmark the execution of a callback while still obtaining the value returned by the callback. The value method will return a tuple containing the value returned by the callback and the number of milliseconds it took to execute the callback:

php

[$count, $duration] = Benchmark::value(fn () => User::count());

Dates

LaraGram includes Tempora, a rewritten version of Carbon, a powerful date and time manipulation library. To create a new Carbon instance, you may invoke the now function. This function is globally available within your LaraGram application:

php

$now = now();

Or, you may create a new Tempora instance using the LaraGram\Support\Tempora class:

php

use LaraGram\Support\Tempora;

$now = Tempora::now();

For a thorough discussion of Carbon and its features, please consult the official Carbon documentation.

Deferred Functions

While LaraGram's queued jobs allow you to queue tasks for background processing, sometimes you may have simple tasks you would like to defer without configuring or maintaining a long-running queue worker.

Deferred functions allow you to defer the execution of a closure until after the HTTP response has been sent to the user, keeping your application feeling fast and responsive. To defer the execution of a closure, simply pass the closure to the LaraGram\Support\defer function:

php

use App\Services\Metrics;
use LaraGram\Request\Request;
use LaraGram\Support\Facades\Bot;
use function LaraGram\Support\defer;

Bot::onText('orders', function (Request $request) {
    // Create order...

    defer(fn () => Metrics::reportOrder($order));

    return $order;
});

By default, deferred functions will only be executed if the HTTP response, Commander command, or queued job from which LaraGram\Support\defer is invoked completes successfully. This means that deferred functions will not be executed if a request results in a 4xx or 5xx HTTP response. If you would like a deferred function to always execute, you may chain the always method onto your deferred function:

php

defer(fn () => Metrics::reportOrder($order))->always();

Cancelling Deferred Functions

If you need to cancel a deferred function before it is executed, you can use the forget method to cancel the function by its name. To name a deferred function, provide a second argument to the LaraGram\Support\defer function:

php

defer(fn () => Metrics::report(), 'reportMetrics');

defer()->forget('reportMetrics');

Lottery

LaraGram's lottery class may be used to execute callbacks based on a set of given odds. This can be particularly useful when you only want to execute code for a percentage of your incoming requests:

php

use LaraGram\Support\Lottery;

Lottery::odds(1, 20)
    ->winner(fn () => $user->won())
    ->loser(fn () => $user->lost())
    ->choose();

You may combine LaraGram's lottery class with other LaraGram features. For example, you may wish to only report a small percentage of slow queries to your exception handler. And, since the lottery class is callable, we may pass an instance of the class into any method that accepts callables:

php

use Carbon\CarbonInterval;
use LaraGram\Support\Facades\DB;
use LaraGram\Support\Lottery;

DB::whenQueryingForLongerThan(
    CarbonInterval::seconds(2),
    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);

Pipeline

LaraGram's Pipeline facade provides a convenient way to "pipe" a given input through a series of invokable classes, closures, or callables, giving each class the opportunity to inspect or modify the input and invoke the next callable in the pipeline:

php

use Closure;
use App\Models\User;
use LaraGram\Support\Facades\Pipeline;

$user = Pipeline::send($user)
    ->through([
        function (User $user, Closure $next) {
            // ...

            return $next($user);
        },
        function (User $user, Closure $next) {
            // ...

            return $next($user);
        },
    ])
    ->then(fn (User $user) => $user);

As you can see, each invokable class or closure in the pipeline is provided the input and a $next closure. Invoking the $next closure will invoke the next callable in the pipeline. As you may have noticed, this is very similar to middleware.

When the last callable in the pipeline invokes the $next closure, the callable provided to the then method will be invoked. Typically, this callable will simply return the given input. For convenience, if you simply want to return the input after it has been processed, you may use the thenReturn method.

Of course, as discussed previously, you are not limited to providing closures to your pipeline. You may also provide invokable classes. If a class name is provided, the class will be instantiated via LaraGram's service container, allowing dependencies to be injected into the invokable class:

php

$user = Pipeline::send($user)
    ->through([
        GenerateProfilePhoto::class,
        ActivateSubscription::class,
        SendWelcomeEmail::class,
    ])
    ->thenReturn();

Sleep

LaraGram's Sleep class is a light-weight wrapper around PHP's native sleep and usleep functions, offering greater testability while also exposing a developer friendly API for working with time:

php

use LaraGram\Support\Sleep;

$waiting = true;

while ($waiting) {
    Sleep::for(1)->second();

    $waiting = /* ... */;
}

The Sleep class offers a variety of methods that allow you to work with different units of time:

php

// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);

// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());

// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();

// Pause execution for 2 seconds...
Sleep::for(2)->seconds();

// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();

// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();

// Pause execution until a given time...
Sleep::until(now()->addMinute());

// Alias of PHP's native "sleep" function...
Sleep::sleep(2);

// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);

To easily combine units of time, you may use the and method:

php

Sleep::for(1)->second()->and(10)->milliseconds();

Timebox

LaraGram's Timebox class ensures that the given callback always takes a fixed amount of time to execute, even if its actual execution completes sooner. This is particularly useful for cryptographic operations and user authentication checks, where attackers might exploit variations in execution time to infer sensitive information.

If the execution exceeds the fixed duration, Timebox has no effect. It is up to the developer to choose a sufficiently long time as the fixed duration to account for worst-case scenarios.

The call method accepts a closure and a time limit in microseconds, and then executes the closure and waits until the time limit is reached:

php

use LaraGram\Support\Timebox;

(new Timebox)->call(function ($timebox) {
    // ...
}, microseconds: 10000);

If an exception is thrown within the closure, this class will respect the defined delay and re-throw the exception after the delay.

Helpers ​

Introduction ​

Available Methods ​

Arrays & Objects ​

Numbers ​

Paths ​

URLs ​

Miscellaneous ​

Arrays & Objects ​

Arr::accessible() ​

Arr::add() ​

Arr::array() ​

Arr::boolean() ​

Arr::collapse() ​

Arr::crossJoin() ​

Arr::divide() ​

Arr::dot() ​

Arr::except() ​

Arr::exists() ​

Arr::first() ​

Arr::flatten() ​

Arr::float() ​

Arr::forget() ​

Arr::from() ​

Arr::get() ​

Arr::has() ​

Arr::hasAll() ​

Arr::hasAny() ​

Arr::integer() ​

Arr::isAssoc() ​

Arr::isList() ​

Arr::join() ​

Arr::keyBy() ​

Arr::last() ​

Arr::map() ​

Arr::mapSpread() ​

Arr::mapWithKeys() ​

Arr::only() ​

Arr::partition() ​

Arr::pluck() ​

Arr::prepend() ​

Arr::prependKeysWith() ​

Arr::pull() ​

Arr::query() ​

Arr::random() ​

Arr::reject() ​

Arr::select() ​

Arr::set() ​

Arr::shuffle() ​

Arr::sole() ​

Arr::sort() ​

Arr::sortDesc() ​

Arr::sortRecursive() ​

Arr::string() ​

Arr::take() ​

Arr::toCssClasses() ​

Arr::toCssStyles() ​

Arr::undot() ​

Arr::where() ​

Arr::whereNotNull() ​

Arr::wrap() ​

data_fill() ​

data_get() ​

data_set() ​

data_forget() ​

head() ​

last() ​

Numbers ​

Number::abbreviate() ​

Number::clamp() ​

Number::currency() ​

Number::defaultCurrency() ​

Number::defaultLocale() ​

Number::fileSize() ​

Number::forHumans() ​

Number::format() ​

Number::ordinal() ​

Number::pairs() ​

Number::parseInt() ​

Number::parseFloat() ​

Helpers

Introduction

Available Methods

Arrays & Objects

Numbers

Paths

URLs

Miscellaneous

Arrays & Objects

`Arr::accessible()`

`Arr::add()`

`Arr::array()`

`Arr::boolean()`

`Arr::collapse()`

`Arr::crossJoin()`

`Arr::divide()`

`Arr::dot()`

`Arr::except()`

`Arr::exists()`

`Arr::first()`

`Arr::flatten()`

`Arr::float()`

`Arr::forget()`

`Arr::from()`

`Arr::get()`

`Arr::has()`

`Arr::hasAll()`

`Arr::hasAny()`

`Arr::integer()`

`Arr::isAssoc()`

`Arr::isList()`

`Arr::join()`

`Arr::keyBy()`

`Arr::last()`

`Arr::map()`

`Arr::mapSpread()`

`Arr::mapWithKeys()`

`Arr::only()`

`Arr::partition()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::prependKeysWith()`

`Arr::pull()`

`Arr::query()`

`Arr::random()`

`Arr::reject()`

`Arr::select()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sole()`

`Arr::sort()`

`Arr::sortDesc()`

`Arr::sortRecursive()`

`Arr::string()`

`Arr::take()`

`Arr::toCssClasses()`

`Arr::toCssStyles()`

`Arr::undot()`

`Arr::where()`

`Arr::whereNotNull()`

`Arr::wrap()`

`data_fill()`

`data_get()`

`data_set()`

`data_forget()`

`head()`

`last()`

Numbers

`Number::abbreviate()`

`Number::clamp()`

`Number::currency()`

`Number::defaultCurrency()`

`Number::defaultLocale()`

`Number::fileSize()`

`Number::forHumans()`

`Number::format()`

`Number::ordinal()`

`Number::pairs()`

`Number::parseInt()`

`Number::parseFloat()`