jeroendesloovere/character-collection

Converts a sentence to a CharacterCollection

Maintainers

Details

github.com/jeroendesloovere/character-collection

Homepage

Source

Issues

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

1.0.0 2018-04-03 09:24 UTC

Requires

  • php: >=7.1

Requires (Dev)

MIT 49cf48a4ded71f25638fd808594b7c38a1233973

This package is auto-updated.

Last update: 2024-11-24 05:34:15 UTC

README

Latest Stable Version License Build Status Scrutinizer Code Quality

Use this class to read a sentence and get all the characters from it in a collection. So you know exactly how many times a character is being used in a sentence.

Installation

composer require jeroendesloovere/character-collection

Example

$collection = new CharacterCollection('This is my sentence.');

Which is a collection of all the characters that are used in your sentence + the positions that they are on. Example off how to get the positions of t

$collection->get('t')->getPositions();

Will return [0, 14].

Documentation

The class is well documented inline. If you use a decent IDE you'll see that each method is documented with PHPDoc.

Contributing

Contributions are welcome and will be fully credited.

Pull Requests

To add or update code

  • Coding Syntax - Please keep the code syntax consistent with the rest of the package.
  • Add unit tests! - Your patch won't be accepted if it doesn't have tests.
  • Document any change in behavior - Make sure the README and any other relevant documentation are kept up-to-date.
  • Consider our release cycle - We try to follow semver. Randomly breaking public APIs is not an option.
  • Create topic branches - Don't ask us to pull from your master branch.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Issues

For bug reporting or code discussions.

More info on how to work with GitHub on help.github.com.

Coding Syntax

We use squizlabs/php_codesniffer to maintain the code standards. Type the following to execute them:

# To view the code errors
vendor/bin/phpcs --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

# OR to fix the code errors
vendor/bin/phpcbf --standard=psr2 --extensions=php --warning-severity=0 --report=full "src"

Read documentation about the code standards

Unit Tests

We have build in tests, type the following to execute them:

vendor/bin/phpunit tests

Credits

License

The module is licensed under MIT. In short, this license allows you to do everything as long as the copyright statement stays present.