dhii/human-readable-interface

Interfaces for human readable string interoperation.

Maintainers

Details

github.com/Dhii/human-readable-interface

Source

Issues

Installs: 54 657

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 1

v0.2.0-alpha1 2021-03-05 00:36 UTC

Requires

  • php: ^7.1 | ^8.0

Requires (Dev)

Suggests

MIT 2b49d664f117faf72fb7af402ad21c0c27c62b6b

  • Dhii Team <development.woop@dhii.co>

This package is auto-updated.

Last update: 2024-12-05 08:47:04 UTC

README

Continuous Integration Latest Stable Version Latest Unstable Version

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 item
  • MessageAwareInterface - 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.