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
• Log-Wrapper
• Minimum Requirements
• Installation
  • For use within your application
  • Standalone-installation / For developing on the php-helper package
• Continuous Integration
  • Check Code Standards
  • Run Unit Tests
  • Static Analysis
• Contributing
• History
• Author and License
• 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. 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

Installation

For use within your application

composer require gyselroth/php-helper

Standalone-installation / For developing the php-helper package

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	Hosted continuous integration service used to build and test software projects
PHPSTan	PHP Static Analyzer
PHPUnit	The PHP Testing Framework
PHP CodeSniffer	Detect violations of defined coding standard (PSR-2)
CodeFactor	Automated Code Review for git

Thanks a lot!

Check Code Standards

phpcs --standard=PSR2 $(find ./src -name '*.php')

Run Unit Tests

vendor/bin/phpunit tests/

or:

composer test

Static Analysis

 vendor/bin/phpstan analyse /srv/www/trunk/src -c /srv/www/trunk/var/ci/phpstan/phpstan.neon

Contributing

See CONTRIBUTING.md

History

See 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.