Download the PHP package sandromiguel/php-type without Composer
On this page you can find all versions of the php package sandromiguel/php-type. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sandromiguel/php-type
More information about sandromiguel/php-type
Files in sandromiguel/php-type
Package php-type
Short Description Validate PHP field values to ensure data integrity and suppress linter alerts.
License MIT
Homepage https://github.com/SandroMiguel/php-type
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-type
PhpType
PhpType is a PHP library meticulously crafted for validating field values, safeguarding data integrity, and quelling linter alerts. It goes beyond mere linting concerns by seamlessly incorporating runtime checks. These runtime checks act as a robust validation layer during code execution, ensuring that your data aligns with the specified types. This dual approach not only suppresses linter warnings but also fortifies your application's integrity, instilling an extra level of confidence in your data handling processes.
Features
- Supports the
int,string,bool, andarraydata types. - Provides a simple and easy-to-use interface.
- Is lightweight and efficient.
- Is well-documented.
Requirements
- PHP 8.1 or higher
Table of Contents
- Installation
- Usage
- Public Methods
- Frequently Asked Questions (FAQ)
- Credits
- Contributing
- License
Installation
You can install this library via Composer. Run the following command:
Usage
This library excels in validating arrays, ensuring that data adheres to specified types and contributing to a more robust and reliable codebase. Consider the following scenarios where PhpType proves beneficial:
Scenario 1: Method Input Validation
When accepting arrays as method parameters, it's crucial to validate the input to guarantee that the data aligns with the expected types. Using PhpType in such scenarios enhances code reliability and prevents unexpected type mismatches.
Example thats shows a linter warning:
Address the previous warning with PhpType:
Scenario 2: Method Output Validation
In situations where it is necessary to return values from an array, such as strings, PhpType ensures that the returned values adhere to the expected types.
Public Methods
-
validate(string $fieldName, mixed $fieldValue): ValidatorStart the validation chain for a field. -
stringNotEmpty(): ValidatorCheck if the string is not empty. -
getArrayValue(): arrayGet the array value. -
getArrayValueOrNull(): ?arrayGet the array value or null. -
getBoolValue(): boolGet the boolean value. -
getBoolValueOrNull(): ?boolGet the boolean value or null. -
getIntValue(): intGet the integer value. -
getIntValueOrNull(): ?intGet the integer value or null. -
getStringValue(): stringGet the string value. -
getStringValueOrNull(): ?stringGet the string value or null. getValue(): mixedGet the mixed value.
Frequently Asked Questions (FAQ)
Q: Why use PhpType when linters like Psalm or PHPStan already exist?
A: While linters are powerful tools, PhpType serves as a lightweight solution specifically designed to handle scenarios where linter warnings arise due to type mismatches in array structures. It provides a simple and easy-to-use interface, offering an alternative approach to address such issues.
Q: Can I use PhpType in production code?
A: Yes, PhpType is intended for use in production code. It is perfectly suitable for production use without any issues.
Q: Why not use deserialization libraries like symfony/serializer for handling array data?
A: Deserialization libraries like symfony/serializer are excellent for handling complex data structures by converting them into objects. PhpType is more suited for scenarios where direct manipulation of arrays is necessary, such as dealing with legacy code or situations where immediate refactoring is not feasible.
Q: How do I handle linter warnings with PhpType?
A: PhpType helps eliminate linter warnings by providing a straightforward method for validating array values, ensuring type correctness, and suppressing alerts from linters like PHPStan. Check the documentation for examples and usage details.
Credits
- EditorConfig: IDE coding style settings.
- PHPUnit: Testing framework for PHP.
- PHP CodeSniffer: PHP coding standards checker and fixer.
- PHP Insights: Code quality and architecture analysis tool.
- PHP Metrics: PHP metrics generator.
- PHPStan: PHP static analysis tool.
- Psalm: Static analysis tool for PHP.
- Composer: Dependency management for PHP.
Contributing
Want to contribute? All contributions are welcome. Read the contributing guide.
Questions
If you have questions tweet me at @sandro_m_m or open an issue.
License
This project is licensed under the MIT License - see the LICENSE file for details
~ sharing is caring ~
