Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sebastiaanluca/php-helpers

THIS PACKAGE HAS BEEN DEPRECATED — An extensive set of PHP helper functions and classes.
https://github.com/sebastiaanluca/php-helpers

array carbon class constants datetime debug functions helpers methods object php string

Last synced: 3 months ago
JSON representation

THIS PACKAGE HAS BEEN DEPRECATED — An extensive set of PHP helper functions and classes.

Host: GitHub
URL: https://github.com/sebastiaanluca/php-helpers
Owner: sebastiaanluca
License: mit
Archived: true
Created: 2018-02-23T00:12:35.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-02-06T03:15:17.000Z (almost 2 years ago)
Last Synced: 2024-07-19T04:34:56.253Z (4 months ago)
Topics: array, carbon, class, constants, datetime, debug, functions, helpers, methods, object, php, string
Language: PHP
Homepage: https://sebastiaanluca.com
Size: 40 KB
Stars: 27
Watchers: 3
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # An extensive set of PHP helper functions and classes

[![Latest stable release][version-badge]][link-packagist]

[![Software license][license-badge]](LICENSE.md)

[![Build status][githubaction-badge]][link-githubaction]

[![Total downloads][downloads-badge]][link-packagist]

[![Total stars][stars-badge]][link-github]

[![Read my blog][blog-link-badge]][link-blog]

[![View my other packages and projects][packages-link-badge]][link-packages]

[![Follow @sebastiaanluca on Twitter][twitter-profile-badge]][link-twitter]

[![Share this package on Twitter][twitter-share-badge]][link-twitter-share]

## Table of contents

- [Requirements](#requirements)

- [How to install](#how-to-install)

- [Global helper functions](#global-helper-functions)

    - [rand_bool](#rand_bool)

    - [str_wrap](#str_wrap)

    - [is\_assoc\_array](#is_assoc_array)

    - [array_expand](#array_expand)

    - [array_without](#array_without)

    - [array\_pull\_value](#array_pull_value)

    - [array\_pull\_values](#array_pull_values)

    - [array_hash](#array_hash)

    - [object_hash](#object_hash)

    - [has\_public\_method](#has_public_method)

    - [carbon](#carbon)

    - [temporary_file](#temporary_file)

- [Class helpers](#class-helpers)

    - [Constants trait](#constants-trait)

        - [Retrieving constants](#retrieving-constants)

        - [Retrieving constant keys](#retrieving-constant-keys)

        - [Retrieving constant values](#retrieving-constant-values)

    - [ProvidesClassInfo trait](#providesclassinfo-trait)

    - [MethodHelper](#methodhelper)

- [License](#license)

- [Change log](#change-log)

- [Testing](#testing)

- [Contributing](#contributing)

- [Security](#security)

- [Credits](#credits)

- [About](#about)

## Requirements

- PHP 8 or higher

## How to install

Via Composer:

```bash

composer require sebastiaanluca/php-helpers

```

All function helpers will be enabled by default (if those functions haven't already been defined). Class helpers are enabled per-case when used.

You can find more info on how to use a helper and what there requirements are in their respective section (see the table of contents above for an overview).

## Global helper functions

### rand_bool

Randomly return `true` or `false`.

```php

rand_bool();

// true

```

### str_wrap

Wrap a string with another string.

```php

str_wrap('foo', '*');

// "*foo*"

```

### is\_assoc\_array

Check if an array is associative.

Performs a simple check to determine if the given array's keys are numeric, start at 0, and count up to the amount of values it has.

```php

is_assoc_array(['color' => 'blue', 'age' => 31]);

// true

```

```php

is_assoc_array([0 => 'blue', 7 => 31]);

// true

```

```php

is_assoc_array(['blue', 31]);

// false

```

```php

is_assoc_array([0 => 'blue', 1 => 31]);

// false

```

### array_expand

Expand a flat dotted array into a multi-dimensional associative array.

If a key is encountered that is already present and the existing value is an array, each new value will be added to that array. If it's not an array, each new value will override the existing one.

```php

array_expand(['products.desk.price' => 200]);

/*

[

    "products" => [

        "desk" => [

            "price" => 200,

        ],

    ],

]

*/

```

### array_without

Get the array without the given values.

Accepts either an array or a value as parameter to remove.

```php

$cars = ['bmw', 'mercedes', 'audi'];

$soldOut = ['audi', 'bmw'];

$inStock = array_without($cars, $soldOut);

// ["mercedes"]

```

```php

array_without(['one', 'two', 'three'], 'two');

// ["one", "three"]

```

### array\_pull\_value

Pull a single value from a given array.

Returns the given value if it was successfully removed from the source array or `null` if it was not found.

```php

$source = ['A', 'B', 'C'];

$removed = array_pull_value($source, 'C');

// $removed = "C"

// $source = ["A", "B"]

```

### array\_pull\_values

Pull an array of values from a given array.

Returns the values that were successfully removed from the source array or an empty array if none were found.

```php

$source = ['A', 'B', 'C'];

$removed = array_pull_values($source, ['A', 'B']);

// $removed = ["A", "B"]

// $source = ["C"]

```

### array_hash

Create a unique string identifier for an array.

The identifier will be entirely unique for each combination of keys and values.

```php

array_hash([1, 2, 3]);

// "262bbc0aa0dc62a93e350f1f7df792b9"

```

```php

array_hash(['hash' => 'me']);

// "f712e79b502bda09a970e2d4d47e3f88"

```

### object_hash

Create a unique string identifier for an object.

Similar to [array_hash](#array_hash), this uses `serialize` to *stringify* all public properties first. The identifier will be entirely unique based on the object class, properties, and its values.

```php

class ValueObject {

    public $property = 'randomvalue';

}

object_hash(new ValueObject);

// "f39eaea7a1cf45f5a0c813d71b5f2f57"

```

### has\_public\_method

Check if a class has a certain public method.

```php

class Hitchhiker {

    public function answer() {

        return 42;

    }

}

has_public_method(Hitchhiker::class, 'answer');

// true

has_public_method(new Hitchhiker, 'answer');

// true

```

### carbon

Create a Carbon datetime object from a string or return a new object referencing the current date and time.

Requires the [nesbot/carbon](https://github.com/briannesbitt/Carbon) package.

```php

carbon('2017-01-18 11:30');

/*

Carbon\Carbon {

    "date": "2017-01-18 11:30:00.000000",

    "timezone_type": 3,

    "timezone": "UTC",

}

*/

carbon();

/*

Carbon\Carbon {

    "date": "2017-10-27 16:18:00.000000",

    "timezone_type": 3,

    "timezone": "UTC",

}

*/

```

### temporary_file

Create a temporary file.

Returns an array with the file handle (resource) and the full path as string.

The temporary file is readable and writeable by default. The file is automatically removed when closed (for example, by calling fclose() on the handle, or when there are no remaining references to the file handle), or when the script ends.

See [](http://php.net/manual/en/function.tmpfile.php) for more information.

```php

temporary_file();

/*

[

    "file" => stream resource {

        timed_out: false

        blocked: true

        eof: false

        wrapper_type: "plainfile"

        stream_type: "STDIO"

        mode: "r+b"

        unread_bytes: 0

        seekable: true

        uri: "/tmp/phpxm4bcZ"

        options: []

    }

    "path" => "/tmp/phpxm4bcZ"

]

*/

```

## Class helpers

### Enum trait

The primary use of the `Enum` trait is to enable you to store all cases of a specific type in a single class or value object and have it return those with a single call.

This can be useful for instance when your database uses integers to store states, but you want to use descriptive strings throughout your code (i.e. enums). It also allows you to refactor these elements at any time without having to waste time searching your code for any raw values (and probably miss a few, introducing new bugs along the way).

#### Retrieving elements

Returns an array of element keys and their values.

```php

enums();

/*

[

    "REGISTERED" => "registered",

    "ACTIVATED" => "activated",

    "DISABLED" => "disabled",

]

*/

```

#### Retrieving element keys

Returns all the keys of the elements in an enum.

```php

getClassDirectory());

    }

}

// "/Users/Kyle/Projects/php-helpers"

```

### MethodHelper

A static class helper to help you figure out the visibility/accessibility of an object's methods.

```php