Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmitry-ivanov/laravel-helper-functions
Laravel-specific and pure PHP Helper Functions.
https://github.com/dmitry-ivanov/laravel-helper-functions
array-to-xml background-command backtrace functions helpers laravel laravel-package multiarray xml-parser xml-to-array
Last synced: 4 days ago
JSON representation
Laravel-specific and pure PHP Helper Functions.
- Host: GitHub
- URL: https://github.com/dmitry-ivanov/laravel-helper-functions
- Owner: dmitry-ivanov
- License: mit
- Created: 2016-06-17T15:34:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T16:53:27.000Z (11 months ago)
- Last Synced: 2025-01-26T20:08:48.894Z (11 days ago)
- Topics: array-to-xml, background-command, backtrace, functions, helpers, laravel, laravel-package, multiarray, xml-parser, xml-to-array
- Language: PHP
- Homepage:
- Size: 727 KB
- Stars: 107
- Watchers: 4
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Helper Functions
[
](https://buymeacoffee.com/dmitry.ivanov)
[](https://github.styleci.io/repos/61384075?branch=master)
[](https://github.com/dmitry-ivanov/laravel-helper-functions/actions?query=workflow%3Atests+branch%3Amaster)
[](https://app.codecov.io/gh/dmitry-ivanov/laravel-helper-functions/tree/master)
Laravel-specific and pure PHP Helper Functions.
| Laravel | Helper Functions |
|---------|-----------------------------------------------------------------------------|
| 11.x | _[Support](https://buymeacoffee.com/dmitry.ivanov)_ ☕ |
| 10.x | [10.x](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/10.x) |
| 9.x | [9.x](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/9.x) |
| 8.x | [8.x](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/8.x) |
| 7.x | [7.x](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/7.x) |
| 6.x | [6.x](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/6.x) |
| 5.8.* | [5.8.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.8) |
| 5.7.* | [5.7.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.7) |
| 5.6.* | [5.6.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.6) |
| 5.5.* | [5.5.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.5) |
| 5.4.* | [5.4.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.4) |
| 5.3.* | [5.3.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.3) |
| 5.2.* | [5.2.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.2) |
| 5.1.* | [5.1.*](https://github.com/dmitry-ivanov/laravel-helper-functions/tree/5.1) |
## Usage
1. Install the package via Composer:
```shell script
composer require illuminated/helper-functions
```
2. Use any of the provided helper functions:
```php
if (is_windows_os()) {
call_in_background('switch-to-mac');
}
```
## Available functions
> Feel free to contribute.
- [Array](#array)
- [array_except_value](#array_except_value)
- [multiarray_set](#multiarray_set)
- [multiarray_sort_by](#multiarray_sort_by)
- [Artisan](#artisan)
- [call_in_background](#call_in_background)
- [Database](#database)
- [db_is_sqlite](#db_is_sqlite)
- [db_is_mysql](#db_is_mysql)
- [db_mysql_now](#db_mysql_now)
- [db_mysql_variable](#db_mysql_variable)
- [Date](#date)
- [to_default_timezone](#to_default_timezone)
- [Debug](#debug)
- [backtrace_as_string](#backtrace_as_string)
- [minimized_backtrace_as_string](#minimized_backtrace_as_string)
- [Email](#email)
- [is_email](#is_email)
- [to_rfc2822_email](#to_rfc2822_email)
- [to_swiftmailer_emails](#to_swiftmailer_emails)
- [to_symfony_emails](#to_symfony_emails)
- [Filesystem](#filesystem)
- [relative_path](#relative_path)
- [Format](#format)
- [get_dump](#get_dump)
- [format_bytes](#format_bytes)
- [format_xml](#format_xml)
- [Json](#json)
- [is_json](#is_json)
- [System](#system)
- [is_windows_os](#is_windows_os)
- [Xml](#xml)
- [xml_to_array](#xml_to_array)
- [array_to_xml](#array_to_xml)
## Array
#### `array_except_value()`
Remove the given values from the array:
```php
array_except_value(['foo', 'bar', 'baz'], 'baz');
// ["foo", "bar"]
```
```php
array_except_value(['foo', 'bar', 'baz'], ['bar', 'baz']);
// ["foo"]
```
#### `multiarray_set()`
Set the value for each item of the multidimensional array using "dot" notation:
```php
$array = [
['name' => 'Mercedes-Benz', 'details' => ['type' => 'SUV']],
['name' => 'BMW', 'details' => ['type' => 'SUV']],
['name' => 'Porsche', 'details' => ['type' => 'SUV']],
];
multiarray_set($array, 'details.country', 'Germany');
// [
// ["name" => "Mercedes-Benz", "details" => ["type" => "SUV", "country" => "Germany"]],
// ["name" => "BMW", "details" => ["type" => "SUV", "country" => "Germany"]],
// ["name" => "Porsche", "details" => ["type" => "SUV", "country" => "Germany"]],
// ]
```
#### `multiarray_sort_by()`
Sort the multidimensional array by several fields:
```php
$array = [
['name' => 'Mercedes-Benz', 'model' => 'GLS', 'price' => 120000],
['name' => 'Mercedes-Benz', 'model' => 'GLE Coupe', 'price' => 110000],
['name' => 'BMW', 'model' => 'X6', 'price' => 77000],
['name' => 'Porsche', 'model' => 'Cayenne', 'price' => 117000],
];
$sorted = multiarray_sort_by($array, 'name', 'model');
// [
// ["name" => "BMW", "model" => "X6", "price" => 77000],
// ["name" => "Mercedes-Benz", "model" => "GLE Coupe", "price" => 110000],
// ["name" => "Mercedes-Benz", "model" => "GLS", "price" => 120000],
// ["name" => "Porsche", "model" => "Cayenne", "price" => 117000],
// ]
```
Also, you can change the sort order:
```php
$array = [
['name' => 'Mercedes-Benz', 'model' => 'GLS', 'price' => 120000],
['name' => 'Mercedes-Benz', 'model' => 'GLE Coupe', 'price' => 110000],
['name' => 'BMW', 'model' => 'X6', 'price' => 77000],
['name' => 'Porsche', 'model' => 'Cayenne', 'price' => 117000],
];
$sorted = multiarray_sort_by($array, 'name', SORT_ASC, 'model', SORT_DESC);
// [
// ["name" => "BMW", "model" => "X6", "price" => 77000],
// ["name" => "Mercedes-Benz", "model" => "GLS", "price" => 120000],
// ["name" => "Mercedes-Benz", "model" => "GLE Coupe", "price" => 110000],
// ["name" => "Porsche", "model" => "Cayenne", "price" => 117000],
// ]
```
## Artisan
#### `call_in_background()`
Call the given artisan console command in background.
Code execution continues immediately, without waiting for results.
```php
call_in_background('report');
// "php artisan report" would be called in background
```
Optional `before` and `after` sub-commands could be used:
```php
call_in_background('report:monthly subscriptions', 'sleep 0.3');
// "sleep 0.3 && php artisan report:monthly subscriptions" would be called in background
```
## Database
#### `db_is_sqlite()`
Check whether the default database connection driver is `sqlite` or not:
```php
db_is_sqlite();
// false
```
#### `db_is_mysql()`
Check whether the default database connection driver is `mysql` or not:
```php
db_is_mysql();
// true
```
#### `db_mysql_now()`
Get the current MySQL datetime:
```php
db_mysql_now();
// "2020-05-25 20:09:33"
```
#### `db_mysql_variable()`
Get value of the specified MySQL variable:
```php
db_mysql_variable('hostname');
// "localhost"
```
## Date
#### `to_default_timezone()`
Convert the given datetime to the default timezone (see `app.timezone` config):
```php
to_default_timezone('2017-02-28T14:05:01Z');
// "2017-02-28 16:05:01", assuming that `app.timezone` is "Europe/Kiev"
```
## Debug
#### `backtrace_as_string()`
Get backtrace without arguments, as a string:
```php
$backtrace = backtrace_as_string();
#0 backtrace_as_string() called at [/htdocs/example/routes/web.php:15]
#1 Illuminate\Routing\Router->{closure}() called at [/htdocs/example/vendor/laravel/framework/src/Illuminate/Routing/Route.php:189]
#2 Illuminate\Foundation\Http\Kernel->handle() called at [/htdocs/example/public/index.php:53]
```
#### `minimized_backtrace_as_string()`
Get minimized backtrace, as a string:
```php
$backtrace = minimized_backtrace_as_string();
#0 /htdocs/example/routes/web.php:15
#1 /htdocs/example/vendor/laravel/framework/src/Illuminate/Routing/Route.php:189
#2 /htdocs/example/public/index.php:53
```
## Email
#### `is_email()`
Check whether the given string is an email address or not:
```php
is_email('[email protected]');
// true
```
#### `to_rfc2822_email()`
Convert addresses data to [RFC 2822](http://faqs.org/rfcs/rfc2822.html) string, suitable for PHP [mail()](https://php.net/manual/en/function.mail.php) function:
```php
to_rfc2822_email([
['address' => '[email protected]', 'name' => 'John Doe'],
['address' => '[email protected]'],
]);
// "John Doe , [email protected]"
```
Also, it supports simplified syntax for a single address:
```php
to_rfc2822_email(['address' => '[email protected]', 'name' => 'John Doe']);
// "John Doe "
```
#### `to_swiftmailer_emails()`
Convert addresses data to [SwiftMailer-suitable format](https://swiftmailer.org/docs/messages.html):
```php
to_swiftmailer_emails([
['address' => '[email protected]', 'name' => 'John Doe'],
['address' => '[email protected]'],
]);
// ["[email protected]" => "John Doe", "[email protected]"]
```
Also, it supports simplified syntax for a single address:
```php
to_swiftmailer_emails(['address' => '[email protected]', 'name' => 'John Doe']);
// ["[email protected]" => "John Doe"]
```
#### `to_symfony_emails()`
Convert addresses data to [Symfony-suitable format](https://symfony.com/doc/current/mailer.html#email-addresses):
```php
to_symfony_emails([
['address' => '[email protected]', 'name' => 'John Doe'],
['address' => '[email protected]'],
]);
// ["John Doe ", "[email protected]"]
```
Also, it supports simplified syntax for a single address:
```php
to_symfony_emails(['address' => '[email protected]', 'name' => 'John Doe']);
// ["John Doe "]
```
## Filesystem
#### `relative_path()`
Get a relative path for the given folders:
```php
relative_path('/var/www/htdocs', '/var/www/htdocs/example');
// "../"
```
You can pass the relative path as a parameter too:
```php
relative_path('/var/www/htdocs/example/public/../../', '/var/');
// "www/htdocs/"
```
## Format
#### `get_dump()`
Get a nicely formatted string representation of the variable, using the [Symfony VarDumper Component](https://symfony.com/doc/current/components/var_dumper/introduction.html):
```php
$array = [
'a simple string' => 'Hello!',
'a float' => 1.0,
'an integer' => 1,
'a boolean' => true,
'an empty array' => [],
];
$dump = get_dump($array);
// array:5 [
// "a simple string" => "Hello!"
// "a float" => 1.0
// "an integer" => 1
// "a boolean" => true
// "an empty array" => []
// ]
```
#### `format_bytes()`
Format bytes into kilobytes, megabytes, gigabytes or terabytes:
```php
format_bytes(3333333);
// "3.18 MB"
```
#### `format_xml()`
Format the given XML string using new lines and indents:
```php
format_xml('JohnJaneGo to the shopJohnPaulFinish the reportJaneJeffClean the house');
//
//
//
// John
// Jane
// Go to the shop
//
//
// John
// Paul
// Finish the report
//
//
// Jane
// Jeff
// Clean the house
//
//
```
## Json
#### `is_json()`
Check whether the given value is a valid JSON-encoded string or not:
```php
is_json('{"foo":1,"bar":2,"baz":3}');
// true
```
It returns decoded JSON if you pass `true` as a second argument:
```php
is_json('{"foo":1,"bar":2,"baz":3}', true);
// ["foo" => 1, "bar" => 2, "baz" => 3]
```
## System
#### `is_windows_os()`
Check whether the operating system is Windows or not:
```php
is_windows_os();
// false
```
## Xml
#### `xml_to_array()`
Convert the given XML to array:
```php
xml_to_array('
Luke Skywalker
Lightsaber
Sauron
Evil Eye
');
// [
// "Good_guy" => [
// "name" => "Luke Skywalker",
// "weapon" => "Lightsaber",
// "@attributes" => [
// "Rating" => "100",
// ],
// ],
// "Bad_guy" => [
// "name" => "Sauron",
// "weapon" => "Evil Eye",
// "@attributes" => [
// "Rating" => "90",
// ],
// ],
// ]
```
Alternatively, you can pass an instance of the `SimpleXMLElement` class instead of a string.
#### `array_to_xml()`
Convert the given array to XML string:
```php
$array = [
'Good guy' => [
'name' => 'Luke Skywalker',
'weapon' => 'Lightsaber',
'@attributes' => [
'Rating' => '100',
],
],
'Bad guy' => [
'name' => 'Sauron',
'weapon' => 'Evil Eye',
'@attributes' => [
'Rating' => '90',
],
]
];
$xml = array_to_xml($array, 'Guys');
//
//
//
// Luke Skywalker
// Lightsaber
//
//
// Sauron
// Evil Eye
//
//
```
## Sponsors
[](https://laravel-idea.com)
[](https://material-theme.com)
## License
Laravel Helper Functions is open-sourced software licensed under the [MIT license](LICENSE.md).
[](https://buymeacoffee.com/dmitry.ivanov)