gavinggordon / phonetictranscriber
A PHP class to transcribe English words into their IPA equivalent.
Requires
- rmccue/requests: ^1.7
This package is not auto-updated.
Last update: 2024-11-09 20:39:43 UTC
README
Description
A PHP class which provides the ability to transcribe American and/or British English words into their IPA (International Phonetic Alphabet) equivalent.
Dependencies
~ ([rmccue/requests ^1.7](https://github.com/rmccue/Requests))
Usage
Installation
$ composer require gavinggordon/phonetictranscriber
Examples
Instantiation:
Include the autoload.php file generated by composer, then instantiate the PhoneticTranscriber class:
include( __DIR__ . '/vendor/autoload.php' ); $transcriber = new GGG\Language\PhoneticTranscriber;
Transcribing:
Get the transcription of a given word, using the default settings:
$transcription = $transcriber->transcribe( 'word' );
Public Methods Overview
- __construct
- set( $property, $value )
- transcribe( $text = NULL )
Important Class Properties
- text_to_transcribe [ string; required ]
- output_dialect [ string; options: 'am' (american), 'br' (british); default: 'am' ]
- output_style [ string; options: 'inline', 'columns', 'text'; default: 'inline' ]
Issues
If you have any issues at all, please post your findings in the issues page at https://github.com/gavinggordon/phonetictranscriber/issues.
License
This package utilizes the MIT License.
More Information
PHP Innovation Award
This class has been nominated for a PHP Innovation Award, provided by PHPClasses.org. If you found this class to be at all interesting, helpful, particularly useful, or innovative in any way, please vote for it, to show your support for this or any other PHP classes accessible online via my GitHub profile or PHPClasses.org profile.