PHPackages                             geoffroy-aubry/helpers - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Debugging & Profiling](/categories/debugging)
4. /
5. geoffroy-aubry/helpers

ActiveLibrary[Debugging & Profiling](/categories/debugging)

geoffroy-aubry/helpers
======================

Some helpers used in several personal packages and a Debug class useful for don't forgetting where debug traces are.

v1.8.0(8y ago)162.0k↓50%[2 issues](https://github.com/geoffroy-aubry/Helpers/issues)8LGPL-3.0+PHPPHP >=5.3.3

Since Apr 1Pushed 8y ago1 watchersCompare

[ Source](https://github.com/geoffroy-aubry/Helpers)[ Packagist](https://packagist.org/packages/geoffroy-aubry/helpers)[ RSS](/packages/geoffroy-aubry-helpers/feed)WikiDiscussions stable Synced 1mo ago

READMEChangelogDependencies (6)Versions (16)Used By (8)

Helpers
=======

[](#helpers)

[![Latest stable version](https://camo.githubusercontent.com/96c7a8ead9668462ec950194358b924e231a51fef2e82de7a5e8d36e7f50800b/68747470733a2f2f706f7365722e707567782e6f72672f67656f6666726f792d61756272792f48656c706572732f762f737461626c652e706e67 "Latest stable version")](https://packagist.org/packages/geoffroy-aubry/Helpers)[![Build Status](https://camo.githubusercontent.com/58a1df582b54cb9d06f1080383304d28d1f41202ef83bec41ce11c351c7ccd5a/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f67656f6666726f792d61756272792f48656c706572732e706e673f6272616e63683d737461626c65)](http://travis-ci.org/geoffroy-aubry/Helpers)[![Coverage Status](https://camo.githubusercontent.com/c6a17d6ce05ae4ab1862ff60a50d18e4518e81b8ad72d38a7a0265737e77d6c0/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f67656f6666726f792d61756272792f48656c706572732f62616467652e706e673f6272616e63683d737461626c65)](https://coveralls.io/r/geoffroy-aubry/Helpers)

Some helpers used in several personal packages and a `Debug` class useful for don't forgetting where debug traces are.

Description
-----------

[](#description)

Two classes:

1. [Helpers](#desc.Helpers),
2. [Debug](#desc.Debug).

### 1. Helpers class

[](#1-helpers-class)

Static methods of `Helpers` class:

- [arrayMergeRecursiveDistinct](#desc.arrayMergeRecursiveDistinct)
- [exec](#desc.exec)
- [flattenArray](#desc.flattenArray)
- [intToMultiple](#desc.intToMultiple)
- [numberFormat](#desc.numberFormat)
- [isAssociativeArray](#desc.isAssociativeArray)
- [round](#desc.round)
- [stripBashColors](#desc.stripBashColors)
- [strPutCSV](#desc.strPutCSV)
- [ucwordWithDelimiters](#desc.ucwordWithDelimiters)
- [utf8Encode](#desc.utf8Encode)
- [getCurrentTimeWithCS](#desc.getCurrentTimeWithCS)
- [dateTimeToTimestamp](#desc.dateTimeToTimestamp)
- [generateMongoId](#desc.generateMongoId)

#### arrayMergeRecursiveDistinct()

[](#arraymergerecursivedistinct)

```
/**
 * array_merge_recursive() does indeed merge arrays, but it converts values with duplicate
 * keys to arrays rather than overwriting the value in the first array with the duplicate
 * value in the second array, as array_merge does. I.e., with array_merge_recursive(),
 * this happens (documented behavior):
 *
 * array_merge_recursive(array('key' => 'org value'), array('key' => 'new value'));
 *     ⇒ array('key' => array('org value', 'new value'));
 *
 * arrayMergeRecursiveDistinct() does not change the datatypes of the values in the arrays.
 * Matching keys' values in the second array overwrite those in the first array, as is the
 * case with array_merge, i.e.:
 *
 * arrayMergeRecursiveDistinct(array('key' => 'org value'), array('key' => 'new value'));
 *     ⇒ array('key' => array('new value'));
 *
 * EVO on indexed arrays:
 *   Before:
 *     arrayMergeRecursiveDistinct(array('a', 'b'), array('c')) => array('c', 'b')
 *   Now:
 *     ⇒ array('c')
 *
 * @param array $aArray1
 * @param array $aArray2
 * @return array An array of values resulted from strictly merging the arguments together.
 * @author Daniel
 * @author Gabriel Sobrinho
 * @author Geoffroy Aubry
 * @see http://fr2.php.net/manual/en/function.array-merge-recursive.php#89684
 */
public static function arrayMergeRecursiveDistinct (array $aArray1, array $aArray2);
```

#### exec()

[](#exec)

```
/**
 * Executes the given shell command and returns an array filled with every line of output from the command.
 * Trailing whitespace, such as \n, is not included in this array.
 * On shell error (exit code  0), throws a \RuntimeException with error message..
 *
 * @param string $sCmd shell command
 * @param string $sOutputPath optional redirection of standard output
 * @param string $sErrorPath optional redirection of standard error
 * @param bool $bAppend true to append to specified files
 * @return array array filled with every line of output from the command
 * @throws \RuntimeException if shell error
 */
public static function exec ($sCmd, $sOutputPath = '', $sErrorPath = '', $bAppend = false);
```

#### flattenArray()

[](#flattenarray)

```
/**
 * Flatten a multidimensional array (keys are ignored).
 *
 * @param array $aArray
 * @return array a one dimensional array.
 * @see http://stackoverflow.com/a/1320156/1813519
 */
public static function flattenArray (array $aArray);
```

Example:

```
$a = array(
    1,
    'a' => array(
        'b' => array('c', 2),
        'd'
    )
);
print_r(Helpers::flattenArray($a));
```

⇒

```
Array(
    [0] => 1
    [1] => 'c'
    [2] => 2
    [3] => 'd'
)
```

#### intToMultiple()

[](#inttomultiple)

```
/**
 * Returns specified value in the most appropriate unit, with that unit.
 * If $bBinaryPrefix is FALSE then use SI units (i.e. k, M, G, T),
 * else use IED units (i.e. Ki, Mi, Gi, Ti).
 * @see http://en.wikipedia.org/wiki/Binary_prefix
 *
 * @param int $iValue
 * @param bool $bBinaryPrefix
 * @return array a pair constituted by specified value in the most appropriate unit and that unit
 */
public static function intToMultiple ($iValue, $bBinaryPrefix = false);
```

Example:

```
print_r(Helpers::intToMultiple(17825792, false));
print_r(Helpers::intToMultiple(17825792, true));
```

⇒

```
Array(
    [0] => 17.825792
    [1] => 'M'
)
Array(
    [0] => 17
    [1] => 'Mi'
)
```

#### numberFormat()

[](#numberformat)

```
/**
 * Format a number with grouped thousands.
 * It is an extended version of number_format() that allows do not specify $decimals.
 *
 * @param float $fNumber The number being formatted.
 * @param string $sDecPoint Sets the separator for the decimal point.
 * @param string $sThousandsSep Sets the thousands separator. Only the first character of $thousands_sep is used.
 * @param int $iDecimals Sets the number of decimal points.
 * @return string A formatted version of $number.
 */
public static function numberFormat ($fNumber, $sDecPoint = '.', $sThousandsSep = ',', $iDecimals = null);
```

#### isAssociativeArray()

[](#isassociativearray)

```
/**
 * Returns TRUE iff the specified array is associative.
 * Returns FALSE if the specified array is empty.
 *
 * http://stackoverflow.com/questions/173400/php-arrays-a-good-way-to-check-if-an-array-is-associative-or-sequential
 *
 * @param array $aArray
 * @return bool true ssi iff the specified array is associative
 */
public static function isAssociativeArray (array $aArray);
```

#### round()

[](#round)

```
/**
 * Rounds specified value with precision $iPrecision as native round() function, but keep trailing zeros.
 *
 * @param float $fValue value to round
 * @param int $iPrecision the optional number of decimal digits to round to (can also be negative)
 * @return string
 */
public static function round ($fValue, $iPrecision = 0);
```

#### stripBashColors()

[](#stripbashcolors)

```
/**
 * Remove all Bash color sequences from the specified string.
 *
 * @param string $sMsg
 * @return string specified string without any Bash color sequence.
 */
public static function stripBashColors ($sMsg);
```

#### strPutCSV()

[](#strputcsv)

```
/**
 * Formats a line passed as a fields array as CSV and return it, without the trailing newline.
 * Inspiration: http://www.php.net/manual/en/function.str-getcsv.php#88773
 *
 * @param array $aInput
 * @param string $sDelimiter
 * @param string $sEnclosure
 * @return string specified array converted into CSV format string
 */
public static function strPutCSV ($aInput, $sDelimiter = ',', $sEnclosure = '"');
```

#### ucwordWithDelimiters()

[](#ucwordwithdelimiters)

```
/**
 * Returns a string with the first character of each word in specified string capitalized,
 * if that character is alphabetic.
 * Additionally, each character that is immediately after one of $aDelimiters will be capitalized too.
 *
 * @param string $sString
 * @param array $aDelimiters
 * @return string
 */
public static function ucwordWithDelimiters ($sString, array $aDelimiters = array());
```

Example:

```
echo Helpers::ucwordWithDelimiters("hel-lo wo'rld", array('-', "'"));
```

⇒

```
"Hel-Lo Wo'Rld"
```

#### utf8Encode()

[](#utf8encode)

```
/**
 * Returns the UTF-8 translation of the specified string, only if not already in UTF-8.
 *
 * @param string $s
 * @return string the UTF-8 translation of the specified string, only if not already in UTF-8.
 */
public static function utf8Encode ($str);
```

#### getCurrentTimeWithCS()

[](#getcurrenttimewithcs)

```
/**
 * Returns current time with hundredths of a second.
 *
 * @param string $sFormat including %s for cs, eg: 'Y-m-d H:i:s.%s'
 * @return string current time with hundredths of a second.
 */
public static function getCurrentTimeWithCS ($sFormat);
```

Example:

```
date_default_timezone_set('UTC');
echo Helpers::getCurrentTimeWithCS('Y-m-d H:i:s');
echo Helpers::getCurrentTimeWithCS('Y-m-d H:i:s.%s');
```

⇒

```
2015-09-07 21:56:06
2015-09-07 21:56:06.579394
```

#### dateTimeToTimestamp()

[](#datetimetotimestamp)

```
/**
 * Returns 'Y-m-d H:i:s[.cs]' date to timestamp, where '.cs' stands for optional hundredths of a second.
 *
 * @param string $sDate at format 'Y-m-d H:i:s[.cs]'
 * @return float 'Y-m-d H:i:s[.cs]' date to timestamp, where '.cs' stands for optional hundredths of a second.
 */
public static function dateTimeToTimestamp ($sDate);
```

Example:

```
date_default_timezone_set('UTC');
echo Helpers::dateTimeToTimestamp('2015-09-07 00:00:00');
echo Helpers::dateTimeToTimestamp('2015-09-07 00:00:00.12');
```

⇒

```
1441584000
1441584000.12
```

#### generateMongoId()

[](#generatemongoid)

```
/**
 * Generates a globally unique id generator using Mongo Object ID algorithm.
 *
 * The 12-byte ObjectId value consists of:
 * - a 4-byte value representing the seconds since the Unix epoch,
 * - a 3-byte machine identifier,
 * - a 2-byte process id, and
 * - a 3-byte counter, starting with a random value.
 * @see https://docs.mongodb.org/manual/reference/method/ObjectId/
 *
 * Uses SKleeschulte\Base32 because base_convert() may lose precision on large numbers due to properties related
 * to the internal "double" or "float" type used.
 * @see http://php.net/manual/function.base-convert.php
 *
 * @param  int    $iTimestamp Default: time()
 * @param  bool   $bBase32 Base32 (RFC 4648) or hex output?
 * @return string 20 base32-char or 24 hex-car MongoId.
 *
 * @see https://www.ietf.org/rfc/rfc4648.txt
 * @see http://stackoverflow.com/questions/14370143/create-mongodb-objectid-from-date-in-the-past-using-php-driver
 */
public static function generateMongoId ($iTimestamp = 0, $bBase32 = true);
```

Example:

```
var_dump(generateMongoId());
var_dump(generateMongoId(time()));
var_dump(generateMongoId(time(), false));
```

⇒

```
string(20) "k34hekzumvsqs2ycyaoa"
string(20) "k34hekzumvsqs2ycyaoq"
string(24) "56f8722b346565096b02c01e"
```

### 2. Debug class

[](#2-debug-class)

Debug class useful for don't forgetting where debug traces are.

Automatically decorates `print_r()` and `var_dump()` with following information:

- file and line of the caller
- name of function/method containing the call
- name of the parameter passed during call

#### Demo

[](#demo)

See [debug.php](examples/debug.php) script for an example:

```
$ php examples/debug.php
```

Here is the result:

[![result of debug.php](examples/debug.png "result of debug.php")](examples/debug.png)

#### htmlVarDump()

[](#htmlvardump)

```
/**
 * Display an HTML trace containing a var_dump() of the specified value.
 *
 * @param mixed $mValue value to pass to var_dump()
 */
public static function htmlVarDump ($mValue);
```

#### htmlPrintr()

[](#htmlprintr)

```
/**
 * Display an HTML trace containing a print_r() of the specified value.
 *
 * @param mixed $mValue value to pass to print_r()
 */
public static function htmlPrintr ($mValue);
```

#### printr()

[](#printr)

```
/**
 * Display a CLI trace containing a print_r() of the specified value.
 *
 * @param mixed $mValue value to pass to print_r()
 */
public static function printr ($mValue);
```

#### varDump()

[](#vardump)

```
/**
 * Display a CLI trace containing a var_dump() of the specified value.
 *
 * @param mixed $mValue value to pass to var_dump()
 */
public static function varDump ($mValue);
```

Usage
-----

[](#usage)

**Helpers** is available via [Packagist](https://packagist.org/packages/geoffroy-aubry/helpers).

1. Class autoloading and dependencies are managed by [Composer](http://getcomposer.org/)so install it following the instructions on [Composer: Installation - \*nix](http://getcomposer.org/doc/00-intro.md#installation-nix)or just run the following command:

```
$ curl -sS https://getcomposer.org/installer | php
```

2. Add dependency to `GAubry\Helpers` into require section of your `composer.json`:

```
    {
        "require": {
            "geoffroy-aubry/helpers": "1.*"
        }
    }
```

and run `php composer.phar install` from the terminal into the root folder of your project.

3. Include Composer's autoloader and use the `GAubry\Helpers` classes:

```