PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Johnny Mast  >  PHP Morse Code  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Morse Code
Encode or decode your Morse code messages
Author: By
Last change: Added license and updated README.md
Added license and updated README.md
Added license and updated README.md
Removed HHVM testing but added php 7.2 and 7.3.
fix decode example in readme
Date: 2 years ago
Size: 2,774 bytes
 

Contents

Class file image Download

Build Status Scrutinizer Code Quality

Morsecode

This package allows you to encode or decode morsecode messages.

Encoding

If you wish to encode your message you can use the encode method.

use johnnymast\Morsecode\Morsecode;

$morse = new Morsecode();
echo $morse->encode('This is a test');

Decoding

If you wish to decode your message you can use the decode method.

use johnnymast\Morsecode\Morsecode;

$morse = new Morsecode();
echo $morse->decode('- .... .. ... / .. ... / .- / - . ... -');

Alternative methods

You can also pass the message you wish you encode or decode via the constructor of the class like so.

use johnnymast\Morsecode\Morsecode;

$morse = new Morsecode('This is a test');
echo $morse->encode();

Return values

The encode and decode methods could return en empty string if no translation could be made. So please take note of this.

Installation

Using composer:

$ composer require johnnymast/morsecode

Requirements

The following versions of PHP are supported by this version.

  • PHP >= 7.0
  • HHVM

Development Requirements

  • PHPUnit 5.7

Author

This package is created and maintained by Johnny Mast. If you have any questions feel free to contact me on twitter by using @mastjohnny in your tweet.

License

MIT License

Copyright (c) 2019 Johnny Mast

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information send a message to info at phpclasses dot org.