From 5afab59be7285f702b1300e8a7f0982cf0dac2b6 Mon Sep 17 00:00:00 2001
From: SteveNay <naylinaung.softwarearchitect@gmail.com>
Date: Tue, 5 Jun 2018 20:13:40 +0630
Subject: [PATCH] [update] user guide and add demo

---
 clients/php/README.md     |  8 ++++----
 samples/php/Demo.php      | 33 +++++++++++++++++++++++++++++++++
 samples/php/composer.json | 19 +++++++++++++++++++
 3 files changed, 56 insertions(+), 4 deletions(-)
 create mode 100644 samples/php/Demo.php
 create mode 100644 samples/php/composer.json

diff --git a/clients/php/README.md b/clients/php/README.md
index dfdd787..135211a 100644
--- a/clients/php/README.md
+++ b/clients/php/README.md
@@ -6,13 +6,13 @@ This documentation is for PHP specific usage of *Myanmar Tools*. For general doc
 
 Prerequisites: PHP >=7.0 and composer >= 1.0
 
-Add the dependency to your project: (Pending)
+Add the dependency to your project:
 
 ```bash
 $ composer install myanmar-tools
 ```
 
-To detect Zawgyi, create an instance of ZawgyiDetector, and call `getZawgyiProbability` with your string. Generally, if the score is greater than or equal to 0.95, you can assume the string is Zawgyi. If the score is lower or equal to 0.05, you can assume it is Unicode.
+To detect Zawgyi, create an instance of ZawgyiDetector, and call `getZawgyiProbability` with your string. Generally, if the score is greater than or equal to 0.95, you can generally assume the string is Zawgyi. If the score is lower or equal to 0.05, you can assume it is Unicode.
 
 ```
 $autoload = __DIR__.'/vendor/autoload.php';
@@ -47,7 +47,7 @@ Rabbit::zg2uni("သီဟိုဠ္မွ ဉာဏ္ႀကီးရွင္
 // output is now "သီဟိုဠ်မှ ဉာဏ်ကြီးရှင်သည် အာယုဝဍ်ဎနဆေးညွှန်းစာကို ဇလွန်ဈေးဘေးဗာဒံပင်ထက် အဓိဋ္ဌာန်လျက် ဂဃနဏဖတ်ခဲ့သည်။"
 ```
 
-For a complete working example, see [samples/php/demo.rb](../../samples/php/demo.php).
+For a complete working example, see [samples/php/Demo.php](../../samples/php/Demo.php).
 
 ## Contributing
 
@@ -55,7 +55,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/google
 
 ## License
 
-The gem is available as open source under the terms of the [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
+The package is available as open source under the terms of the [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
 
 ## Code of Conduct
 
diff --git a/samples/php/Demo.php b/samples/php/Demo.php
new file mode 100644
index 0000000..9a7f42b
--- /dev/null
+++ b/samples/php/Demo.php
@@ -0,0 +1,33 @@
+<?php
+// include autoload
+$autoload = join(DIRECTORY_SEPARATOR, [__DIR__, "vendor", "autoload.php"]);
+if (!file_exists($autoload))
+    exit("Need Composer!");
+require $autoload;
+
+use Googlei18n\MyanmarTools\ZawgyiDetector;
+
+$detector = new ZawgyiDetector();
+
+// Unicode string
+$unicodeInput = 'အပြည်ပြည်ဆိုင်ရာ လူ့အခွင့်အရေး ကြေညာစာတမ်း';
+
+// Zawgyi string
+$zawgyiInput = 'အျပည္ျပည္ဆိုင္ရာ လူ႔အခြင့္အေရး ေၾကညာစာတမ္း';
+
+$unicodeScore = $detector->getZawgyiProbability($unicodeInput);
+$zawgyiScore  = $detector->getZawgyiProbability($zawgyiInput);
+
+assert($unicodeScore < 0.001);
+assert($zawgyiScore > 0.999);
+
+printf("Unicode Score: %.6f", $unicodeScore);
+echo "<br />";
+printf("Zawgyi Score: %.6f", $zawgyiScore);
+
+echo "<br />";
+
+// Convert the second string to Unicode:
+$zawgyi2UniConverted = Rabbit::zg2uni($zawgyiInput);
+assert($unicodeInput === $zawgyi2UniConverted, "Converted string is equal to unicode");
+printf("Converted Text: %s\n", $zawgyi2UniConverted);
diff --git a/samples/php/composer.json b/samples/php/composer.json
new file mode 100644
index 0000000..382ed0f
--- /dev/null
+++ b/samples/php/composer.json
@@ -0,0 +1,19 @@
+{
+    "name": "googlei18n/myanmar-tools-sample",
+    "description": "Sample for how to use myanmar-tools detector",
+    "license": "MIT",
+    "keywords": [
+        "sample"
+    ],
+    "homepage": "https://developers.google.com/international",
+    "authors": [
+        {
+            "name": "googlei18n",
+            "email": "sample@gmail.com"
+        }
+    ],
+    "type": "project",
+    "require": {
+        "googlei18n/myanmar-tools": ">=0.1.0"
+    }
+}
\ No newline at end of file