Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shahmal1yev/gcollection
GenericCollection is a versatile PHP library that provides a type-safe collection class for managing various data types. Simplify your data management with intuitive methods and strong type constraints.
https://github.com/shahmal1yev/gcollection
collection generics package php74
Last synced: about 1 month ago
JSON representation
GenericCollection is a versatile PHP library that provides a type-safe collection class for managing various data types. Simplify your data management with intuitive methods and strong type constraints.
- Host: GitHub
- URL: https://github.com/shahmal1yev/gcollection
- Owner: shahmal1yev
- Created: 2024-07-27T20:21:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T22:30:03.000Z (4 months ago)
- Last Synced: 2024-09-29T20:01:18.504Z (about 2 months ago)
- Topics: collection, generics, package, php74
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHP-based GenericCollection
[](https://opensource.org/licenses/MIT)
`GenericCollection` is a PHP library for handling collections with support for various primitive types. It allows for flexible type validation and manipulation of collections.
## Features
- **Flexible Type Handling**: Supports various primitive types such as `int`, `string`, `float`, `bool`, and more.
- **Type Validation**: Provides methods to validate if an item in the collection adheres to the specified type.
- **Extensible**: Easily extendable to support custom types and validation logic.
## Dependencies
```json
{
"require": {
"php": ">=7.4"
},
"require-dev": {
"phpunit/phpunit": "9.6.20"
}
}
```
## Installation
You can install `GenericCollection` via Composer. If you don't have Composer installed, you can get it from [getcomposer.org](https://getcomposer.org).
Run the following command to install `GenericCollection`:
```bash
composer require shahmal1yev/gcollection
```
## Usage
Here is a basic example of how to use the `GenericCollection`:
```php
add(1, new Foo);
// Retrieve items from the collection
echo $collection[0];
echo $collection->get(1); // Outputs: Foo as string
// Validate an item
var_dump($collection->validate(new Foo)); // Outputs: bool(true)
```
```php
add(1, "World");
// Retrieve items from the collection
echo $collection[1];
echo $collection->get(0); // Outputs: Hello
// Validate an item
var_dump($collection->validate("Test")); // Outputs: bool(true)
```
## Available Primitive Types
`GenericCollection` includes the following primitive types:
- **IntType**: Validates integer values.
- **StringType**: Validates string values.
- **FloatType**: Validates float values.
- **BoolType**: Validates boolean values.
- **ObjectType**: Validates object values.
- **CallableType**: Validates callable values.
- **ResourceType**: Validates resource values.
- **IterableType**: Validates iterable values.
## Contributing
Contributions are welcome! Please follow these steps to contribute to the project:
1. **Fork the Repository**: Create a personal copy of the repository by forking it on GitHub.
2. **Create a Branch**: Create a new branch for your changes.
3. **Make Changes**: Implement your changes or fix issues.
4. **Submit a Pull Request**: Push your changes and submit a pull request for review.
## Running Tests
To run the tests, make sure you have PHPUnit installed. You can install it via Composer:
```bash
composer require --dev phpunit/phpunit:9.6.20
```
Run the tests with the following command:
```bash
vendor/bin/phpunit ./tests
```
## License
This project is licensed under the MIT License. For more information, see the [LICENSE](https://opensource.org/license/MIT).
## Contact
For any questions or feedback, please contact us at [LinkedIn](https://linkedin.com/in/shahmal1yev).