diff --git a/LICENSE.md b/LICENSE.md index bc5674f..6a920d6 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008 by Yii Software () All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - * Neither the name of Yii Software nor the names of its +* Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 532c84b..71b2a27 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ composer require yiisoft/hydrator-validator Validating hydrator is a [hydrator](https://github.com/yiisoft/hydrator) decorator that allows to validate raw data before passing it to the decorated hydrator and to validate object after creating or populating it. -To use it, the object being validated must implement `ValidatedInputInterface`. You can use `ValidatedInputTrait` to +To use it, the object being validated must implement `ValidatedInputInterface`. You can use `ValidatedInputTrait` to easily create such object. The validation rules for raw values of the object are defined with `Validate` PHP attribute. Example of object: @@ -62,7 +62,7 @@ final class InputDto implements ValidatedInputInterface Validation result could be obtained via its `getValidationResult()` method. -Validating hydrator usage example: +Validating hydrator usage example: ```php use Yiisoft\Hydrator\HydratorInterface; @@ -83,14 +83,12 @@ public function actionEdit(RequestInterface $request, ValidatingHydrator $hydrat ## Documentation -- [Internals](docs/internals.md) +- More information can be found in the [Internals.](docs/internals.md) -## License - -The Yii Validating Hydrator is free software. It is released under the terms of the BSD License. -Please see [`LICENSE`](./LICENSE.md) for more information. +## Support -Maintained by [Yii Software](https://www.yiiframework.com/). +If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. +You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). ## Support the project @@ -103,3 +101,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/). [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en) [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk) [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack) + +## License + +The Yii Validating Hydrator is free software. It is released under the terms of the BSD License. +Please see [`LICENSE`](./LICENSE.md) for more information. + +Maintained by [Yii Software](https://www.yiiframework.com/). diff --git a/docs/internals.md b/docs/internals.md index b715d9f..8dc4049 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -34,10 +34,9 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Dependencies +## Composer require checker -Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive -[Composer](https://getcomposer.org/) dependencies. +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command: