josantonius / str
PHP library for string handler.
Requires
- php: ^5.6 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.3 || ^2.8
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^5.7 || ^6.0
- squizlabs/php_codesniffer: ^3.0
README
PHP library for string handler.
- Requirements
- Installation
- Available Methods
- Quick Start
- Usage
- Tests
- TODO
- Contribute
- Repository
- License
- Copyright
Requirements
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
Installation
The preferred way to install this extension is through Composer.
To install PHP Str library, simply:
$ composer require Josantonius/Str
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
$ composer require Josantonius/Str --prefer-source
You can also clone the complete repository with Git:
$ git clone https://github.com/Josantonius/PHP-Str.git
Or install it manually:
$ wget https://raw.githubusercontent.com/Josantonius/PHP-Str/master/src/Str.php
Available Methods
- Check if the string starts with a certain value:
Str::startsWith($search, $string);
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| $search | The string to search. | string | Yes | |
| $string | The string where search. | string | Yes |
# Return (boolean)
- Check if the string ends with a certain value:
Str::endsWith($search, $string);
| Attribute | Description | Type | Required | Default |
|---|---|---|---|---|
| $search | The string to search. | string | Yes | |
| $string | The string where search. | string | Yes |
# Return (boolean)
Quick Start
To use this library with Composer:
require __DIR__ . '/vendor/autoload.php'; use Josantonius\Str\Str;
Or If you installed it manually, use it:
require_once __DIR__ . '/Str.php'; use Josantonius\Str\Str;
Usage
Example of use for this library:
- Check if the string starts with a certain value:
Str::startsWith("Hello", "Hello world");
- Check if the string ends with a certain value:
Str::endsWith("world", "Hello World");
Tests
To run tests you just need composer and to execute the following:
$ git clone https://github.com/Josantonius/PHP-Str.git
$ cd PHP-Str
$ composer install
Run unit tests with PHPUnit:
$ composer phpunit
Run PSR2 code standard tests with PHPCS:
$ composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
$ composer phpmd
Run all previous tests:
$ composer tests
☑ TODO
- Add new feature.
- Improve tests.
- Improve documentation.
- Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.
Contribute
If you would like to help, please take a look at the list of issues or the To Do checklist.
Pull requests
- Fork and clone.
- Run the command
composer installto install the dependencies. This will also install the dev dependencies. - Run the command
composer fixto excute code standard fixers. - Run the tests.
- Create a branch, commit, push and send me a pull request.
Repository
The file structure from this repository was created with PHP-Skeleton.
License
This project is licensed under MIT license. See the LICENSE file for more info.
Copyright
2017 - 2018 Josantonius, josantonius.com
If you find it useful, let me know 😉