DownloadUtility - Collection of various PHP utility functions.
Utility is a small collection of useful functions that are aimed to make developers' lives just a tad bit easier.
Installation
Composer
Install the latest version with:
$ composer require esi/utility
Then, within your project (if not already included), include composer's autoload. For example:
<?php
require 'vendor/autoload.php';
?>
Basic Usage
Utility is a set of classes that are broken down into several "components":
Utilities
* Arrays
* Conversion
* Dates
* Environment
* Filesystem
* Image
* Numbers
* Strings
As an example, let's say you want to convert a string to title case. To do so: <?php
use Esi\Utility\Strings;
$title = Strings::title('this is my title');
echo $title;
?>
All methods of found within Utility's classes are static. So, for example, to retrieve the information for a particular timezone:
<?php
use Esi\Utility\Dates;
$timezone = Dates::timezoneInfo('America/New_York');
print_r($timezone);
/*
Array
(
[offset] => -5
[country] => US
[latitude] => 40.71416
[longitude] => -74.00639
[dst] =>
)
*/
?>
Documentation
Please see docs or view online.
About
Requirements
-
Utility works with PHP 8.2.0 or above.
Submitting bugs and feature requests
Bugs and feature requests are tracked on GitHub
Issues are the quickest way to report a bug. If you find a bug or documentation error, please check the following first:
-
That there is not an Issue already open concerning the bug
-
That the issue has not already been addressed (within closed Issues, for example)
Contributing
Utility accepts contributions of code and documentation from the community.
These contributions can be made in the form of Issues or Pull Requests on the Utility repository.
Utility is licensed under the MIT license. When submitting new features or patches to Utility, you are giving permission to license those features or patches under the MIT license.
Utility tries to adhere to PHPStan level 9 with strict rules and bleeding edge. Please ensure any contributions do as well.
Guidelines
Before we look into how, here are the guidelines. If your Pull Requests fail to pass these guidelines it will be declined, and you will need to re-submit when you?ve made the changes. This might sound a bit tough, but it is required for me to maintain quality of the code-base.
PHP Style
Please ensure all new contributions match the PSR-12 coding style guide. The project is not fully PSR-12 compatible, yet; however, to ensure the easiest transition to the coding guidelines, I would like to go ahead and request that any contributions follow them.
Documentation
If you change anything that requires a change to documentation then you will need to add it. New methods, parameters, changing default values, adding constants, etc. are all things that will require a change to documentation. The change-log must also be updated for every change. Also, PHPDoc blocks must be maintained.
Documenting functions/variables (PHPDoc)
Please ensure all new contributions adhere to:
when documenting new functions, or changing existing documentation.
Branching
One thing at a time: A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests.
Author
Eric Sizemore - <admin@secondversion.com> - <https://www.secondversion.com>
License
Utility is licensed under the MIT License - see the LICENSE file for details
Acknowledgements
This library is inspired by Brandon Wamboldt's utilphp library.
|