Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gyselroth/php-helper
PHP helpers upon primitive data types and common data structures
https://github.com/gyselroth/php-helper
array client date filesystem helper html image library numeric php php7 server string xml zip
Last synced: 4 days ago
JSON representation
PHP helpers upon primitive data types and common data structures
- Host: GitHub
- URL: https://github.com/gyselroth/php-helper
- Owner: gyselroth
- License: other
- Created: 2018-05-31T09:54:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T09:44:02.000Z (almost 4 years ago)
- Last Synced: 2024-04-02T15:06:56.561Z (8 months ago)
- Topics: array, client, date, filesystem, helper, html, image, library, numeric, php, php7, server, string, xml, zip
- Language: PHP
- Homepage:
- Size: 669 KB
- Stars: 4
- Watchers: 5
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
PHP Helper
==========
[](//packagist.org/packages/gyselroth/php-helper)
[](https://travis-ci.org/gyselroth/php-helper)
[](https://www.codefactor.io/repository/github/gyselroth/php-helper/overview/master)
[](https://raw.githubusercontent.com/gyselroth/php-helper/master/LICENSE)
[](//packagist.org/packages/gyselroth/php-helper)
[](//packagist.org/packages/gyselroth/php-helper)
[](//packagist.org/packages/gyselroth/php-helper)
PHP helper methods upon primitive data types (Array, Float, Integer, String, etc.)
and common data structures (e.g. HTML, ZIP, XML etc.).
## Table of contents
* [Features](#features)
* [Log-Wrapper](#log-wrapper)
* [Minimum Requirements](#minimum-requirements)
* [Installation](#installation)
* [For use within your application](#for-use-within-your-application)
* [Standalone-installation / For developing on the php-helper package](#standalone-installation--for-developing-the-php-helper-package)
* [Continuous Integration](#continuous-integration)
+ [Check Code Standards](#check-code-standards)
+ [Run Unit Tests](#run-unit-tests)
+ [Static Analysis](#static-analysis)
* [Contributing](#contributing)
* [History](#history)
* [Author and License](#author-and-license)
* [Used Open Source Software](#used-open-source-software)
Features
--------
Provides helpers for conversion-/modification-, validation-, extraction-/search-, and many more for:
* Date/Time handling
* File I/O
* HTML
* Image
* JSON
* Numeric
* Reflection
* Server/Client
* String
* XML
* ZIP
### Log-Wrapper
This package uses the [gyselroth logger wrapper](https://github.com/gyselroth/php-helper-log).
See it's documentation for further info on how to setup and use it from within PHP applications of different
frameworks.
Minimum Requirements
--------------------
* See [composer.json](https://github.com/gyselroth/php-helper/blob/master/composer.json)
Installation
------------
### For use within your application
```sh
composer require gyselroth/php-helper
```
### Standalone-installation / For developing the php-helper package
```sh
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
composer install
```
Continuous Integration
------------------------
php-helper is continuously checked regarding it's stability, code quality and standards using these third party tools:
| Tool | Description |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| [Travis CI](https://travis-ci.org/) | Hosted continuous integration service used to build and test software projects |
| [PHPSTan](https://phpstan.org/) | PHP Static Analyzer |
| [PHPUnit](https://phpunit.de/) | The PHP Testing Framework |
| [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) | Detect violations of defined coding standard (PSR-2) |
| [CodeFactor](https://www.codefactor.io/) | Automated Code Review for git |
Thanks a lot!
### Check Code Standards
```sh
phpcs --standard=PSR2 $(find ./src -name '*.php')
```
### Run Unit Tests
```sh
vendor/bin/phpunit tests/
```
or:
```sh
composer test
```
### Static Analysis
```sh
vendor/bin/phpstan analyse /srv/www/trunk/src -c /srv/www/trunk/var/ci/phpstan/phpstan.neon
```
Contributing
------------
See [CONTRIBUTING.md](https://github.com/gyselroth/php-helper/blob/master/CONTRIBUTING.md)
History
-------
See [CHANGELOG.md](https://github.com/gyselroth/php-helper/blob/master/CHANGELOG.md)
Author and License
------------------
Copyright 2017-2020 gyselroth™ (http://www.gyselroth.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0":http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Used Open Source Software
Open source packages used by the gyselroth Helper Library are copyright of their vendors, see related licenses within
the vendor packages.