library helpers

andrey-helldar/helpers

Helpers that simplify the development process

Helpers for Laravel 5.5+

Functions that simplify the development process., _(*1)

, _(*2)

, _(*3)

Attention

This package is abandoned and no longer maintained. The author suggests using the andrey-helldar/support package instead., _(*4)

Installation

To get the latest version of Helpers, simply require the project using Composer:, _(*5)

$ composer require andrey-helldar/helpers

Instead, you may of course manually update your require block and run composer update if you so choose:, _(*6)

{
    "require": {
        "andrey-helldar/helpers": "^1.0"
    }
}

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php:, _(*7)

Helldar\Helpers\LaravelServiceProvider::class,

You can also publish the config file to change implementations (ie. interface to specific class):, _(*8)

php artisan vendor:publish --provider="Helldar\Helpers\ServiceProvider"

Now you can use helpers or access directly to interfaces., _(*9)

Enjoy!, _(*10)

Documentation

Menu

• Arrays
  • array_item_value_max_length
  • array_add_unique
  • array_rename_keys
  • array_size_max_value
  • array_sort_by_keys_array
• Digits
  • factorial
  • short_number
• Dumper
  • dd_sql
• Files
  • url_file_exists
• Http
  • mix_url
  • base_url
  • build_url
  • subdomain_name
• Jsonable
• Images
  • image_or_default
• Notifications
• Strings
  • str_choice
  • e
  • de
  • str_replace_spaces
• Systems
  • is_windows
  • is_linux

Arrays

array_item_value_max_length()

Returns the number of characters of the longest element in the array:, _(*11)

echo array_item_value_max_length(array $array = []) : int

echo (new \Helldar\Helpers\Support\Arr(array $array = []))
    ->arrayItemValueMaxLength() : int

array_add_unique()

Push one a unique element onto the end of array:, _(*12)

array_add_unique(array &$array, $value)

(new \Helldar\Helpers\Support\Arr())
    ->addUnique(&$array, $value = 'value')

(new \Helldar\Helpers\Support\Arr())
    ->addUnique(&$array, $value = ['value1', 'value2', ...])

array_rename_keys()

Renaming array keys. As the first parameter, a callback function is passed, which determines the actions for processing the value. The output of the function must be a string with a name., _(*13)

return array_rename_keys($callback, array $array = []) : array

return (new \Helldar\Helpers\Support\Arr(array $array = []))
    ->arrayRenameKeys($callback) : array

array_size_max_value()

Get the size of the longest text element of the array:, _(*14)

return array_size_max_value(array $array = []) : int

return (new \Helldar\Helpers\Support\Arr((array $array = []))
    ->arraySizeOfMaxValue() : int

array_sort_by_keys_array()

Sort an associative array in the order specified by an array of keys., _(*15)

array_sort_by_keys_array($array, $sorter) : void

(new \Helldar\Helpers\Support\Arr())
    ->sortByKeysArray($array, $sorter) : void

Example:

$arr = ['q' => 1, 'r' => 2, 's' => 5, 'w' => 123];

array_sort_by_keys_array($arr, ['q', 'w', 'e']);

print_r($arr);

/*
Array
(
    [q] => 1
    [w] => 123
    [r] => 2
    [s] => 5
)

[ to top | to menu ], _(*16)

Digits

factorial()

Calculating the factorial of a number:, _(*17)

echo factorial(int $n = 0) : int

echo (new \Helldar\Helpers\Support\Digits())
    ->factorial(int $n = 0) : int

short_number()

Converts a number into a short version:, _(*18)

echo short_number($n = 0, $precision = 1) : int|string

echo (new \Helldar\Helpers\Support\Digits($n = 0))
    ->shortNumber($precision = 1) : int|string

Example:

short_number(576);
// returns: 576

short_number(1000);
// returns: 1K

short_number(1440);
// returns: 1.4K

short_number(3000000);
// returns: 3M

short_number(3000000000);
// returns: 3B

short_number(3000000000000);
// returns: 3T+

[ to top | to menu ], _(*19)

Dumper

dd_sql()

Dump the passed variables and end the script., _(*20)

return dd_sql($query, bool $is_short = false, bool $is_return = false) : array|string|void

return (new \Helldar\Helpers\Support\Dumper($query))
    ->ddSql($is_short, $is_return) : array|string|void

[ to top | to menu ], _(*21)

Files

url_file_exists()

Checks whether a file or directory exists on URL:, _(*22)

return url_file_exists($path) : bool

return (new \Helldar\Helpers\Support\Files($path))
    ->urlFileExists() : bool

[ to top | to menu ], _(*23)

Http

mix_url()

Convert the relative path of a versioned Mix files to absolute., _(*24)

return mix_url($path) : string

return (new \Helldar\Helpers\Support\Http($path))
    ->mixUrl() : string

base_url()

Get the domain name from the URL., _(*25)

return base_url($url) : string

return (new \Helldar\Helpers\Support\Http($url))
    ->baseUrl() : string

build_url()

Reverse function for parse_url() (http://php.net/manual/en/function.parse-url.php)., _(*26)

The code is taken from gist.github.com/Ellrion, _(*27)

$parts1 = [
    'scheme' => 'http',
    'host'   => 'mysite.dev',
];

$parts2 = [
    'scheme'   => 'https',
    'host'     => 'mysite.dev',
    'port'     => 1234,
    'user'     => 'foo',
    'pass'     => 'bar',
    'path'     => '/category/subcategory',
    'query'    => 'page=1',
    'fragment' => 'section=5',
];

return build_url($parts1) : string
return (new \Helldar\Helpers\Support\Http($parts2))
    ->buildUrl();

// returned 1: http://mysite.dev
// returned 2: https://foo:bar@mysite.dev:1234/category/subcategory?page=1#section=5

subdomain_name()

Retrieving the current subdomain name., _(*28)

return subdomain_name();

return (new \Helldar\Helpers\Support\Http())
    ->getSubdomain();

// from domain `test.mysite.local` will return `test` (string).
// from domain `mysite.local` will return `null` (null).

[ to top | to menu ], _(*29)

Jsonable

Convert the object to its JSON representation., _(*30)

The code is taken from gist.github.com/Ellrion, _(*31)

use Helldar\Traits\Jsonable;

class MyClass
{
    use Jsonable;

    public function __construct($data)
    {
        $this->setData($data);
    }
}

$obj = new MyClass($data);
echo $obj->toJson();

[ to top | to menu ], _(*32)

Images

image_or_default()

Check the existence of the file and return the default value if it is missing:, _(*33)

echo image_or_default(string $filename, $default = null) : string

echo (new \Helldar\Helpers\Support\Images($filename))
    ->imageOrDefault($default = null) : string

[ to top | to menu ], _(*34)

Notifications

Notification helpers were placed in a separate package andrey-helldar/notify-exceptions., _(*35)

[ to top | to menu ], _(*36)

Strings

str_choice()

The str_choice function translates the given language line with inflection:, _(*37)

echo str_choice(int $num, array $choice = [], string $additional = '') : string

echo (new \Helldar\Helpers\Support\Str($num))
    ->choice(array $choice = [], string $additional = '') : string

Example:

echo str_choice(1, ['пользователь', 'пользователя', 'пользователей']);
// returned "пользователь"

echo str_choice(3, ['пользователь', 'пользователя', 'пользователей']);
// returned "пользователя"

echo str_choice(20, ['пользователь', 'пользователя', 'пользователей']);
// returned "пользователей"

echo str_choice(20, ['пользователь', 'пользователя', 'пользователей'], 'здесь');
// returned "пользователей здесь"

e()

Escape HTML special characters in a string:, _(*38)

echo e($value) : string

echo (new \Helldar\Helpers\Support\Str($value))
    ->e() : string

de()

Convert special HTML entities back to characters:, _(*39)

echo de($value) : string

echo (new \Helldar\Helpers\Support\Str($value))
    ->de() : string

str_replace_spaces()

Replacing multiple spaces with a single space., _(*40)

echo str_replace_spaces($value) : string

echo (new \Helldar\Helpers\Support\Str($value))
    ->replaceSpaces() : string

[ to top | to menu ], _(*41)

Systems

is_windows()

Determine whether the current environment is Windows based:, _(*42)

return is_windows() : bool

return (new \Helldar\Helpers\Support\System())
    ->isWindows() : bool

is_linux()

Determine whether the current environment is Linux based:, _(*43)

return is_linux() : bool

return (new \Helldar\Helpers\Support\System())
    ->isLinux() : bool

[ to top | to menu ], _(*44)

Copyright and License

Helpers was written by Andrey Helldar for the Laravel framework 5.5 or later, and is released under the MIT License. See the LICENSE file for details., _(*45)

Translation

Translations of text and comment by Google Translate. Help with translation +1 in karma :), _(*46)