pixel418/ubiq

Functions for readable treatment of string, array & object

Ubiq

Functions for readable treatment of string, array & object., _(*1)

1. Let's code
   1.1 Simple
   1.2 Readable
   1.3 Normalized
2. Documentation
   2.1 String manipulation
   2.2 Array manipulation
   2.3 Object manipulation
3. How to Install
4. How to Contribute
5. Author & Community

Let's code

Simple

With Ubiq, your treatments are simple., _(*2)

$string = 'example.com/my/path';
\UString::substrBefore( $string, '/' );
// Returns 'example.com'
// Instead of usual implementation: substr( $string, 0, strpos( $string, '/' ) );

↑ top, _(*3)

Readable

With Ubiq, even your complex treatments still readable., _(*4)

$string = 'example.com/my/path';
\UString::substrBefore( $string, '/' );
// Returns 'example.com'

\UString::substrBefore( $string, [ '/', '.' ] );
// Returns 'example'

\UString::substrBeforeLast( $string, [ '/', '.' ] );
// Returns 'example.com/my'

↑ top, _(*5)

Normalized

Ubiq has consistent and normalized api., _(*6)

$string = 'my/path';
// Without prefix, the method return the result of the treatment
\UString::startWith( $string, '/' );
// Returns '/my/path'

$string = 'my/path';
// With 'is' prefix, the method return the result of the test
\UString::isStartWith( $string, '/' );
// Returns FALSE

$string = 'my/path';
// With 'do' prefix, the method treat by reference
\UString::doStartWith( $string, '/' );
// $string value is now '/my/path'

↑ top, _(*7)

How to Install

If you don't have composer, you have to install it., _(*8)

Add or complete the composer.json file at the root of your repository, like this :, _(*9)

{
    "require": {
        "pixel418/ubiq": "0.4.*"
    }
}

Ubiq can now be downloaded via composer., _(*10)

To use it, you just have to load the composer autoloader :, _(*11)

require_once( './vendor/autoload.php' );

↑ top, _(*12)

How to Contribute

1. Fork the Ubiq repository
2. Create a new branch for each feature or improvement
3. Send a pull request from each feature branch to the develop branch

If you don't know much about pull request, you can read the Github article., _(*13)

All pull requests must follow the PSR1 standard and be accompanied by passing phpunit tests., _(*14)

↑ top, _(*15)

Author & Community

Ubiq is under the MIT License.
It is created and maintained by Thomas ZILLIOX., _(*16)

↑ top, _(*17)