Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Turns (large) integers into easier to remember Japanese sounding words and vice versa.
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/Blendwerk/Mnemo
tests
.travis.yml
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

Mnemo

Build Status

Turns (large) integers into easier to remember Japanese sounding words and vice versa.

This is a port of the Ruby module rufus-mnemo.

Requirements

This library uses PSR-0 compliant namespaces, thus requiring PHP 5.3 or later.

There are no further dependencies.

Installation

This library is available as a Composer package. Add the following to your composer.json file:

{
    "require": {
        "blendwerk/mnemo": "master"
    }
}

Alternatively clone this repo and use a PSR-0 compliant autoloader or manually require Mnemo.php.

Usage

<?php

use Blendwerk\Mnemo\Mnemo;

Mnemo::fromInteger(125704);
  # => "karasu"

Mnemo::toInteger('karasu');
  # => 125704

Mnemo::fromInteger(-173866);
  # => winamote (Negative integers are prefixed with the "wi" syllable.)

Mnemo::isMnemoWord('kazuma');
  # => true

Mnemo::isMnemoWord('richard');
  # => false

?>

Project Home

This project can be found on https://github.com/aleksblendwerk/Mnemo.

Motivation

I mainly started this project as an exercise in current open source and PHP standards:

While none of these are entirely new to me, I felt the urge to go through the whole process once and have a proper project applying best practices out there, hopefully paving the way for many more to come.

Credits

  • John Mettraux, the author of the original Ruby module rufus-mnemo

License

Mnemo is licensed under the MIT license.

Something went wrong with that request. Please try again.