Merge branch 'development' of github.com:TextControl/txtextcontrol-re…

…portingcloud-php into development
TextControl · Feb 25, 2019 · 5157999 · 5157999
2 parents 625f2b7 + 2174081
commit 5157999
Show file tree

Hide file tree

Showing 26 changed files with 271 additions and 142 deletions.
diff --git a/bin/build-cultures.php b/bin/build-cultures.php
@@ -25,6 +25,7 @@
 use TxTextControl\ReportingCloud\Assert\Assert;
 use TxTextControl\ReportingCloud\Exception\RuntimeException;
 use TxTextControl\ReportingCloud\Stdlib\ArrayUtils;
+use TxTextControl\ReportingCloud\Stdlib\ConsoleUtils;
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -44,7 +45,7 @@
 }
 
 if (0 === count($values)) {
-    $format  = 'Cannot download the available cultures from %s';
+    $format  = 'Cannot download the available cultures from "%s".';
     $message = sprintf($format, $url);
     throw new RuntimeException($message);
 }
@@ -61,11 +62,9 @@
 ArrayUtils::varExportToFile($filename, $values, $generator);
 
 echo PHP_EOL;
-echo sprintf('The available cultures (%d) are %s.', count($values), implode(', ', $values));
-echo PHP_EOL;
-echo PHP_EOL;
-echo sprintf('Written data file to %s', $filename);
+ConsoleUtils::writeLn('The available cultures (%d) are %s.', count($values), implode(', ', $values));
 echo PHP_EOL;
+ConsoleUtils::writeLn('Written data file to "%s".', $filename);
 echo PHP_EOL;
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/bin/build-dictionaries.php b/bin/build-dictionaries.php
@@ -47,11 +47,9 @@
 ArrayUtils::varExportToFile($filename, $values, $generator);
 
 echo PHP_EOL;
-echo sprintf('The available dictionaries (%d) are %s.', count($values), implode(', ', $values));
-echo PHP_EOL;
-echo PHP_EOL;
-echo sprintf('Written data file to %s', $filename);
+ConsoleUtils::writeLn('The available dictionaries (%d) are %s.', count($values), implode(', ', $values));
 echo PHP_EOL;
+ConsoleUtils::writeLn('Written data file to "%s".', $filename);
 echo PHP_EOL;
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/demo/api-key-management.php b/demo/api-key-management.php
@@ -10,22 +10,16 @@
 
 $reportingCloud = new ReportingCloud([
     'api_key' => ConsoleUtils::apiKey(),
+    'test'    => true,
 ]);
 
-$apiKeys = $reportingCloud->getApiKeys();
-
-if (!empty($apiKeys)) {
-    foreach ($apiKeys as $apiKey) {
-        if ($apiKey['key'] == ConsoleUtils::apiKey()) {
-            echo sprintf("Keeping API key %s...", $apiKey['key']);
-            echo PHP_EOL;
-            continue;
-        }
-        echo sprintf("Deleting API key %s...", $apiKey['key']);
-        echo PHP_EOL;
-        $reportingCloud->deleteApiKey($apiKey['key']);
-        unset($apiKey);
+foreach ($reportingCloud->getApiKeys() as $apiKey) {
+    if ($apiKey['key'] === ConsoleUtils::apiKey()) {
+        ConsoleUtils::writeLn('Keeping API key "%s".', $apiKey['key']);
+        continue;
     }
+    ConsoleUtils::writeLn('Deleting API key "%s".', $apiKey['key']);
+    $reportingCloud->deleteApiKey($apiKey['key']);
 }
 
 $newApiKey = $reportingCloud->createApiKey();
@@ -38,7 +32,8 @@
     'api_key' => $newApiKey,
 ]);
 
-dump($reportingCloud->getAccountSettings());
-dump($reportingCloud->getTemplateList());
+ConsoleUtils::dump($reportingCloud->getAccountSettings());
+
+ConsoleUtils::dump($reportingCloud->getTemplateList());
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/demo/append-document-advanced.php b/demo/append-document-advanced.php
@@ -9,31 +9,32 @@
 
 $reportingCloud = new ReportingCloud([
     'api_key' => ConsoleUtils::apiKey(),
+    'test'    => true,
 ]);
 
 $documents = [
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
 ];
 
 $destinationFilename = sprintf('%s/test_append_document_advanced.pdf', Path::output());
 
 $documentSettings = [
-    'author'                 => 'James Henry Trotter',
+    'author'                 => 'Wikipedia',
     'creation_date'          => time(),
-    'creator_application'    => 'An awesome creator',
-    'document_subject'       => 'The Old Green Grasshopper',
-    'document_title'         => 'James and the Giant Peach',
+    'creator_application'    => 'ReportingCloud PHP SDK',
+    'document_subject'       => 'The Mechanical Turk',
+    'document_title'         => 'Mälzel and the Machine',
     'last_modification_date' => time(),
     'user_password'          => '1',
 ];
@@ -46,5 +47,4 @@
 
 file_put_contents($destinationFilename, $binaryData);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/append-document-basic.php b/demo/append-document-basic.php
@@ -9,19 +9,20 @@
 
 $reportingCloud = new ReportingCloud([
     'api_key' => ConsoleUtils::apiKey(),
+    'test'    => true,
 ]);
 
 $documents = [
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
     [
-        'filename' => sprintf('%s/test_document.docx', Path::resource()),
+        'filename' => sprintf('%s/maelzel_machine.docx', Path::resource()),
         'divider'  => ReportingCloud::DOCUMENT_DIVIDER_NEW_SECTION,
     ],
 ];
@@ -35,5 +36,4 @@
 
 file_put_contents($destinationFilename, $binaryData);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/convert-document-docx-to-pdf.php b/demo/convert-document-docx-to-pdf.php
@@ -11,19 +11,17 @@
     'api_key' => ConsoleUtils::apiKey(),
 ]);
 
-$sourceFilename      = sprintf('%s/test_document.docx', Path::resource());
-$destinationFilename = sprintf('%s/test_document.pdf', Path::output());
+$sourceFilename      = sprintf('%s/maelzel_machine.docx', Path::resource());
+$destinationFilename = sprintf('%s/maelzel_machine.pdf', Path::output());
 
 $document = $reportingCloud->convertDocument(
     $sourceFilename,
     ReportingCloud::FILE_FORMAT_PDF
 );
 
 if (empty($document)) {
-    echo sprintf('Error converting "%s".', $sourceFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('Error converting "%s".', $sourceFilename);
 } else {
     file_put_contents($destinationFilename, $document);
-    echo sprintf('"%s" was converted and written to "%s".', $sourceFilename, $destinationFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('"%s" was converted and written to "%s".', $sourceFilename, $destinationFilename);
 }
diff --git a/demo/convert-document-pdf-to-txt.php b/demo/convert-document-pdf-to-txt.php
@@ -11,19 +11,17 @@
     'api_key' => ConsoleUtils::apiKey(),
 ]);
 
-$sourceFilename      = sprintf('%s/camera_controls.pdf', Path::resource());
-$destinationFilename = sprintf('%s/camera_controls.txt', Path::output());
+$sourceFilename      = sprintf('%s/maelzel_machine.pdf', Path::resource());
+$destinationFilename = sprintf('%s/maelzel_machine.txt', Path::output());
 
 $document = $reportingCloud->convertDocument(
     $sourceFilename,
     ReportingCloud::FILE_FORMAT_TXT
 );
 
 if (empty($document)) {
-    echo sprintf('Error converting "%s".', $sourceFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('Error converting "%s".', $sourceFilename);
 } else {
     file_put_contents($destinationFilename, $document);
-    echo sprintf('"%s" was converted and written to "%s".', $sourceFilename, $destinationFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('"%s" was converted and written to "%s".', $sourceFilename, $destinationFilename);
 }
diff --git a/demo/find-and-replace-document.php b/demo/find-and-replace-document.php
@@ -45,5 +45,4 @@
 
 file_put_contents($destinationFilename, $binaryData);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/get-account-settings.php b/demo/get-account-settings.php
@@ -10,4 +10,6 @@
     'api_key' => ConsoleUtils::apiKey(),
 ]);
 
-dump($reportingCloud->getAccountSettings());
+foreach ($reportingCloud->getAccountSettings() as $key => $value) {
+    ConsoleUtils::writeLn('- %s: %s', $key, $value);
+}
diff --git a/demo/get-template-info.php b/demo/get-template-info.php
@@ -24,5 +24,5 @@
         $reportingCloud->uploadTemplate($sourceFilename);
     }
 
-    dump($reportingCloud->getTemplateInfo($templateName));
+    ConsoleUtils::dump($reportingCloud->getTemplateInfo($templateName));
 }
diff --git a/demo/get-template-thumbnails.php b/demo/get-template-thumbnails.php
@@ -45,8 +45,7 @@
 
     file_put_contents($destinationFilename, $binaryData);
 
-    echo sprintf('"%s" was written to "%s".', $templateName, $destinationFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('"%s" was written to "%s".', $templateName, $destinationFilename);
 }
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/demo/instantiation.php b/demo/instantiation.php
@@ -4,6 +4,7 @@
 include_once __DIR__ . '/bootstrap.php';
 
 use TxTextControl\ReportingCloud\ReportingCloud;
+use TxTextControl\ReportingCloud\Stdlib\ConsoleUtils;
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -13,7 +14,7 @@
     'api_key' => 'xxxxxxxx',
 ]);
 
-dump($reportingCloud);
+ConsoleUtils::dump($reportingCloud);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -23,7 +24,7 @@
 
 $reportingCloud->setApiKey('xxxxxxxx');
 
-dump($reportingCloud);
+ConsoleUtils::dump($reportingCloud);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -39,7 +40,7 @@
     'debug'    => true,
 ]);
 
-dump($reportingCloud);
+ConsoleUtils::dump($reportingCloud);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -55,6 +56,6 @@
 $reportingCloud->setTimeout(100);
 $reportingCloud->setDebug(true);
 
-dump($reportingCloud);
+ConsoleUtils::dump($reportingCloud);
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/demo/list-fonts.php b/demo/list-fonts.php
@@ -10,4 +10,6 @@
     'api_key' => ConsoleUtils::apiKey(),
 ]);
 
-dump($reportingCloud->getFontList());
+foreach ($reportingCloud->getFontList() as $font) {
+    ConsoleUtils::writeLn('- %s', $font);
+}
diff --git a/demo/merge-document-advanced.php b/demo/merge-document-advanced.php
@@ -9,7 +9,6 @@
 
 $reportingCloud = new ReportingCloud([
     'api_key' => ConsoleUtils::apiKey(),
-    'test'    => true,
 ]);
 
 // ---------------------------------------------------------------------------------------------------------------------
@@ -98,8 +97,7 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -125,8 +123,7 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -172,8 +169,7 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -200,8 +196,7 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
 
 // ---------------------------------------------------------------------------------------------------------------------
 
@@ -236,8 +231,7 @@
 
     file_put_contents($destinationFilename, $binaryData);
 
-    echo sprintf('Written to "%s".', $destinationFilename);
-    echo PHP_EOL;
+    ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
 }
 
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/demo/merge-document-basic.php b/demo/merge-document-basic.php
@@ -29,5 +29,4 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/merge-document-html.php b/demo/merge-document-html.php
@@ -39,5 +39,4 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/merge-document-image.php b/demo/merge-document-image.php
@@ -36,5 +36,4 @@
 
 file_put_contents($destinationFilename, $arrayOfBinaryData[0]);
 
-echo sprintf('Written to "%s".', $destinationFilename);
-echo PHP_EOL;
+ConsoleUtils::writeLn('Written to "%s".', $destinationFilename);
diff --git a/demo/proofing.php b/demo/proofing.php
@@ -10,8 +10,8 @@
     'api_key' => ConsoleUtils::apiKey(),
 ]);
 
-dump($reportingCloud->getAvailableDictionaries());
+ConsoleUtils::dump($reportingCloud->getAvailableDictionaries());
 
-dump($reportingCloud->getProofingSuggestions('ssky', 'en_US.dic', 10));
+ConsoleUtils::dump($reportingCloud->getProofingSuggestions('ssky', 'en_US.dic', 10));
 
-dump($reportingCloud->proofingCheck('Thiss is a testt about rockkets in the ssky', 'en_US.dic'));
+ConsoleUtils::dump($reportingCloud->proofingCheck('Thiss is a testt about rockkets in the ssky', 'en_US.dic'));