dhii / human-readable-interface
Interfaces for human readable string interoperation.
Installs: 53 014
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: ^7.1 | ^8.0
Requires (Dev)
- phpunit/phpunit: ^6.0 | ^7.0 | ^8.0 | ^9.0
- slevomat/coding-standard: ^6.0
- symfony/polyfill-php80: ^1.19
- vimeo/psalm: ^3.11.7 | ^4.0
Suggests
- dhii/i18n-interface: For internationalizing and translating human readable strings.
- symfony/polyfill-php80: To add Stringable interface
This package is auto-updated.
Last update: 2024-11-05 08:42:26 UTC
README
Interfaces for human-readable string interoperation.
Details
Use the interfaces in this package to represent things that expose human-readable strings. Then perhaps base rendering logic on them.
Interfaces
CaptionAwareInterface- Something that has a caption. Usually a descriptive sub-heading. Perhaps for images.DescriptionAwareInterface- Something that has a description. Should describe the object. Settings fields usually use this.LabelAwareInterface- Something that has a label. This is something that visually names the object. Setting fields usually use this, or maybe a tab or a menu itemMessageAwareInterface- Something that has a message. Perhaps a notification object.TitleAwareInterface- Something that has a title. Could be page.
Development
This project ships with Docker and PHPStorm configurations. Just
copy .env.example to .env, tweak if necessary, then use
docker-compose to run various tools, or use PHPStorm integrations.