README

A comprehensive collection of PHP utility functions and helpers for various tasks including date manipulation, web operations, text processing, and more. This is a meta-package that includes all the Valksor function sub-libraries.

Installation

Install the package via Composer:

composer require valksor/php-functions

This will install all the function sub-libraries at once.

Requirements

• PHP 8.4 or higher
• Various PHP extensions (curl, json, random)
• Symfony components (http-foundation, intl, process, property-access, routing, string)

Included Sub-libraries

This meta-package includes the following function libraries:

• valksor/php-functions-date - Date and time manipulation utilities
• valksor/php-functions-handler - Error and exception handling utilities
• valksor/php-functions-iteration - Array and collection iteration utilities
• valksor/php-functions-latvian - Latvian language specific utilities
• valksor/php-functions-local - Localization and internationalization utilities
• valksor/php-functions-memoize - Function result caching utilities
• valksor/php-functions-number - Number manipulation and formatting utilities
• valksor/php-functions-pagination - Pagination utilities for arrays and collections
• valksor/php-functions-php - PHP language enhancement utilities
• valksor/php-functions-preg - Regular expression utilities
• valksor/php-functions-queue - FIFO queue implementation for managing collections of items
• valksor/php-functions-sort - Sorting algorithms and utilities
• valksor/php-functions-text - Text processing and manipulation utilities
• valksor/php-functions-web - Web-related utilities for HTTP requests, URLs, etc.

Each sub-library can also be installed individually if you only need specific functionality.

Usage

Each sub-library has its own usage instructions. Please refer to the README.md file in each sub-library's directory for specific usage examples.

Generally, there are two ways to use these libraries:

1. Via the Functions class provided by each sub-library
2. By directly using the traits in your own classes

Contributing

Contributions are welcome! Please read our Contributing Guidelines for details on:

• Code style requirements (PSR-12)
• Testing requirements for PRs
• One feature per pull request
• Development setup instructions

To contribute to function libraries:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/new-function)
3. Implement your function following existing patterns
4. Add comprehensive tests
5. Ensure all tests pass and code style is correct
6. Submit a pull request

Creating New Function Libraries

When adding new function libraries:

1. Create namespace under Valksor\Functions\{Name}
2. Implement Functions class and individual traits
3. Add comprehensive test coverage in tests/Functions/{Name}/
4. Create composer.json with proper dependencies
5. Update meta-package composer.json to include new library
6. Update documentation with examples

Security

If you discover any security-related issues, please email us at security@valksor.dev instead of using the issue tracker.

For security policy and vulnerability reporting guidelines, please see our Security Policy.

Support

• Documentation: Full documentation
• Issues: GitHub Issues for bug reports and feature requests
• Discussions: GitHub Discussions for questions and community support
• Stack Overflow: Use tag valksor-php-functions
• Individual Library Support: Each library has dedicated documentation

Credits

• Original Author - Creator and maintainer
• All Contributors - Thank you to all who contributed
• PHP Community - Language and ecosystem support
• Symfony Components - Many functions utilize Symfony components
• Valksor Project - Part of the larger Valksor PHP ecosystem

License

This package is licensed under the BSD-3-Clause License.

About Valksor

This package is part of the valksor/php-valksor project - a comprehensive PHP library and Symfony bundle that provides a collection of utilities, components, and integrations for Symfony applications.

The main project includes:

• Various utility functions and components
• Doctrine ORM tools and extensions
• Symfony bundle for easy configuration
• And much more

If you find these function components useful, you might want to check out the full Valksor project for additional tools and utilities that can enhance your Symfony application development.

To install the complete package:

composer require valksor/php-valksor