Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplepie/utility-pack
A set of small utilities for PHP.
https://github.com/simplepie/utility-pack
enum parser php php72 php73 php74 querystring simplepie time types url util
Last synced: 1 day ago
JSON representation
A set of small utilities for PHP.
- Host: GitHub
- URL: https://github.com/simplepie/utility-pack
- Owner: simplepie
- License: apache-2.0
- Created: 2017-05-28T01:09:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-03T22:45:36.000Z (almost 5 years ago)
- Last Synced: 2024-04-25T22:40:26.994Z (7 months ago)
- Topics: enum, parser, php, php72, php73, php74, querystring, simplepie, time, types, url, util
- Language: PHP
- Size: 312 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
----
# Utility Pack
A set of small utilities for PHP 7.2+.
## Badges
### Health
[](https://github.com/simplepie/utility-pack/issues)
[](https://github.com/simplepie/utility-pack/pulls)
[](https://github.com/simplepie/utility-pack/graphs/contributors)
[](https://github.com/simplepie/utility-pack/pulse/monthly)
[](https://github.com/simplepie/utility-pack/commits/master)
[](https://github.com/simplepie/utility-pack/commits)
### Quality
[](https://travis-ci.org/simplepie/utility-pack)
[](https://coveralls.io/github/simplepie/utility-pack)
[](https://scrutinizer-ci.com/g/simplepie/utility-pack)
[](https://insight.symfony.com/projects/ea218481-dce7-434a-8a3c-bd9cd9818cca)
### Social
[](https://twitter.com/skyzyx)
[](https://twitter.com/intent/follow?screen_name=simplepie_ng)
[](https://medium.com/simplepie-ng)
[](https://github.com/simplepie/utility-pack/stargazers)
### Compliance
[](https://github.com/simplepie/utility-pack/blob/master/LICENSE.md)
## Usage
### QueryString
Believe it or not, different PHP installations can have different default values for generating query strings. This class uses explicit rules so that query strings are always generated exactly the same way. Leverages [`http_build_query()`](http://php.net/manual/en/function.http-build-query.php) under the hood.
```php
'a',
'order' => 'b',
'offset' => 'c',
]);
#=> limit=a&order=b&offset=c
```
### Time
Simple constants for time. Makes time calculations easier to read and understand.
```php
1, 2, 10
echo sprintf('%s, %s, %s', 1 * Time::MINUTE, 2 * Time::MINUTES, 10 * Time::MINUTES);
#=> 60, 120, 600
echo sprintf('%s, %s, %s', 1 * Time::HOUR, 2 * Time::HOURS, 10 * Time::HOURS);
#=> 3600, 7200, 36000
echo sprintf('%s, %s, %s', 1 * Time::DAY, 2 * Time::DAYS, 10 * Time::DAYS);
#=> 86400, 172800, 864000
echo sprintf('%s, %s, %s', 1 * Time::WEEK, 2 * Time::WEEKS, 10 * Time::WEEKS);
#=> 604800, 1209600, 6048000
echo 0.5 * Time::YEAR;
#=> 15778800
```
You can also use the standard ISO-8601 format, with _second_ granularity, and set to UTC _“Zulu”_ time (using the _Z_ annotation).
```php
2017-05-28T01:46:06Z
```
### Type
You can easily get the scalar type or classname of any object.
```php
')
);
#=> SimpleXMLElement
echo Types::getClassOrType(
new DateTime(
'now',
new DateTimeZone('UTC')
)
);
#=> DateTime
echo Types::getClassOrType('string'));
#=> string
echo Types::getClassOrType(111));
#=> integer
echo Types::getClassOrType(111.0));
#=> double
echo Types::getClassOrType(true));
#=> boolean
echo Types::getClassOrType(false));
#=> boolean
```
## Coding Standards
PSR-1/2/5/12/19 are a solid foundation, but are not an entire coding style by themselves. We automate a large part of our style requirements using [PHP CS Fixer](http://cs.sensiolabs.org) and [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). (The things that we cannot yet automate are documented in the [SimplePie NG Coding Standards](https://github.com/simplepie/simplepie-ng-coding-standards).)
These can be applied/fixed automatically by running the (lightweight) linter:
```bash
make lint
```
Additionally, in our quest to write excellent code, we use a variety of tools to help us catch issues with what we've written, including:
| Type | Description |
| ---- | ----------- |
| Linting Tools | [PHP CS Fixer](http://cs.sensiolabs.org), [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) |
| QA Tools | [PDepend](https://github.com/pdepend/pdepend), [PHPLOC](https://github.com/sebastianbergmann/phploc), [PHP Copy/Paste Detector](https://github.com/sebastianbergmann/phpcpd), [PHP Code Analyzer](https://github.com/wapmorgan/PhpCodeAnalyzer) |
| Static Analysis | [Phan](https://github.com/phan/phan), [PHPStan](https://github.com/phpstan/phpstan), [Psalm](https://github.com/vimeo/psalm), [PHP Dependency Analysis](https://github.com/mamuz/PhpDependencyAnalysis) |
These reports can be generated by running the (heavyweight) analyzer:
```bash
make analyze
```
## Please Support or Sponsor Development
The SimplePie project is a labor of love. Development of the next-generation of SimplePie was started in June 2017 as because it's a project I love, and I believe our community would benefit from this tool.
If you use SimplePie — especially to make money — it would be swell if you could kick down a few bucks. As the project grows, and we start leveraging more services and architecture, it would be great if it didn't all need to come out of my pocket.
You can also sponsor the development of a particular feature. If there's a feature that you want to see implemented, and I believe it's the right fit for the SimplePie project, you can sponsor the development of the feature to get it prioritized.
Your contributions are greatly and sincerely appreciated. See the **Sponsor** button along the top of the page for more information.