Merge branch 'master' of https://github.com/docusign/code-examples-php-private

Author: AaronWDS

Quick_ACG/src/RouterService.php

@@ -3,6 +3,7 @@
 namespace QuickACG;
 
 use Example\Services\CodeGrantService;
+use Example\Services\ManifestService;
 use Example\Services\IRouterService;
 
 class RouterService implements IRouterService
@@ -15,10 +16,6 @@ class RouterService implements IRouterService
         'eg001' => 'esignature/quickEmbeddedSigning.html'
     ];
 
-    private const TITLES = [
-        'eg001' => 'Use embedded signing'
-    ];
-
     private const SESSION_VALUES = [
         'ds_access_token',
         'ds_refresh_token',
@@ -70,6 +67,7 @@ public function router(): void
                 break;
             default:
                 error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING & ~E_DEPRECATED);
+                $_SESSION['API_TEXT'] = ManifestService::loadManifestData(ManifestService::getLinkToManifestFile('eSignature'));
                 $controller = '\Example\\' . $this->getController($page);
                 new $controller($page);
                 break;
@@ -177,6 +175,6 @@ public function getTemplate($eg): string
      */
     public function getTitle($eg): string
     {
-        return self::TITLES[$eg];
+        return ManifestService::getPageText($eg)["ExampleName"];
     }
 }

README.md

@@ -23,37 +23,41 @@ The OAuth library is used in the file [index.php](./public/index.php).
 
 ## eSignature API
 
-For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).
+For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).  
 
-For a list of code examples that use the eSignature API, select the PHP tab under [Examples and languages](https://developers.docusign.com/docs/esign-rest-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
+For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the DocuSign Developer Center.
 
-## Rooms API
 
-**Note:** To use the Rooms API you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account.  
-For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/). 
+## Rooms API 
 
-For a list of code examples that use the Rooms API, select the PHP tab under [Examples and languages](https://developers.docusign.com/docs/rooms-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
- 
-## Click API
+**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account.  
+For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/).  
 
-For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes).
+For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the DocuSign Developer Center.
+
+
+## Click API  
+For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes)  
+
+For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the DocuSign Developer Center.
 
-For a list of code examples that use the Click API, select the PHP tab under [Examples and languages](https://developers.docusign.com/docs/click-api/how-to/code-launchers#examples-and-languages) on the DocuSign Developer Center.
 
 ## Monitor API
-**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).   
-For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/).
 
-For a list of code examples that use the Monitor API, select the PHP tab under [Examples and languages](https://developers.docusign.com/docs/monitor-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
+**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).  
+
+For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/). 
+
+For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the DocuSign Developer Center.
 
 
 ## Admin API
-**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
 
-For more information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
+**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
 
-For a list of code examples that use the Admin API, select the PHP tab under [Examples and languages](https://developers.docusign.com/docs/admin-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
+For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
 
+For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center.
 
 ## Installation
 

composer.json

@@ -4,7 +4,14 @@
                   "DocuSign\\OAuth2\\Client\\Provider\\": "src/"
                  }
     },
- 
+    "scripts": {
+        "post-install-cmd": [
+            "@code-sniffer"
+        ],
+        "post-update-cmd": [
+            "@code-sniffer"
+        ]
+    },
     "require": {
         "docusign/admin-client": "1.1.0",
         "docusign/click-client": "1.1.0",
@@ -16,6 +23,7 @@
         "ext-json": "*",
         "guzzlehttp/guzzle": "7.4.5",
         "firebase/php-jwt": "5.5.1",
-        "mashape/unirest-php": "3.0.4"
+        "mashape/unirest-php": "3.0.4",
+        "squizlabs/php_codesniffer": "*"
     }
 }

ds_config_example.php

@@ -29,7 +29,13 @@
     'gateway_name' => "stripe",
     'gateway_display_name' => "Stripe",
     'github_example_url' => 'https://github.com/docusign/code-examples-php/tree/master/src/Controllers/Examples',
-    'documentation' => false
+    'documentation' => false,
+    // Manifest files
+    "ESignatureManifest" => "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/eSignatureManifest.json",
+    "ClickManifest" => "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/ClickManifest.json",
+    "RoomsManifest" => "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/RoomsManifest.json",
+    "MonitorManifest" => "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/MonitorManifest.json",
+    "AdminManifest" => "https://raw.githubusercontent.com/docusign/code-examples-csharp/master/manifest/AdminManifest.json"
 ];
 
 $JWT_CONFIG = [

phpcs.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<ruleset name="igmaDev">
+    <file>src/Controllers</file>
+    <file>src/Services</file>
+    <file>src/EG001EmbeddedSigning.php</file>
+    <file>public/index.php</file>
+    <exclude-pattern>*/docs/*</exclude-pattern>
+    <exclude-pattern>*/templates/*</exclude-pattern>
+    <exclude-pattern>*/public/assets/*</exclude-pattern>
+    <exclude-pattern>*/public/demo_documents/*</exclude-pattern>
+    <arg name="extensions" value="php" />
+    <rule ref="PEAR">
+        <exclude name="PEAR.Commenting.FunctionCallSignature.CloseBracketLine" />
+        <exclude name="PEAR.Files.IncludingFile.UseInclude" />
+        <exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket" />
+        <exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine" />
+        <exclude name="PEAR.Functions.FunctionCallSignature.Indent" />
+        <exclude name="PEAR.NamingConventions.ValidVariableName.PrivateNoUnderscore" />
+        <exclude name="PEAR.WhiteSpace.ObjectOperatorIndent.Incorrect" />
+    </rule>
+    <rule ref="PSR2">
+        <exclude name="PSR2.Methods.FunctionCallSignature.CloseBracketLine" />
+        <exclude name="PSR2.Methods.FunctionCallSignature.ContentAfterOpenBracket" />
+        <exclude name="PSR2.Methods.FunctionCallSignature.Indent" />
+    </rule>
+    <rule ref="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter" />
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="90"/>
+            <property name="absoluteLineLimit" value="130"/>
+        </properties>
+    </rule>
+    <rule ref="Generic.Commenting.DocComment.MissingShort">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Generic.Commenting.DocComment.TagValueIndent">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Generic.Commenting.DocComment.ContentAfterOpen">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Generic.Commenting.DocComment.ContentBeforeClose">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax" />
+</ruleset>

public/assets/css.css

@@ -144,4 +144,8 @@ pre.json-display {
 .your-class div{
 float:left;
 margin-left: 10px;
+}
+
+.chooseApiTypeStyle {
+  padding-left: 0;
 }

src/Controllers/AdminApiBaseController.php

@@ -32,6 +32,8 @@ public function controller(
     {
         $method = $_SERVER['REQUEST_METHOD'];
 
+        $this->codeExampleText = $this->getPageText(static::EG);
+        
         if (!$this->routerService) {
             $this->routerService = new RouterService();
         }
@@ -67,7 +69,8 @@ private function getController(
         if ($this->isHomePage(static::EG)) {
             $GLOBALS['twig']->display(static::EG . '.html', [
                 'title' => $this->homePageTitle(static::EG),
-                'show_doc' => false
+                'show_doc' => false,
+                'common_texts' => $this->getCommonText()
             ]);
         }
         else
@@ -83,6 +86,8 @@ private function getController(
                     'permission_profiles' => $permission_profiles,
                     'export_id' => isset($_SESSION['export_id']),
                     'import_id' => isset($_SESSION['import_id']),
+                    'code_example_text' => $this->codeExampleText,
+                    'common_texts' => $this->getCommonText()
                 ]);
             }
             else {

src/Controllers/BaseController.php

@@ -2,10 +2,14 @@
 
 namespace Example\Controllers;
 
+use Example\Services\ManifestService;
+
 abstract class BaseController
 {
 
     protected const DEMO_DOCS_PATH = __DIR__ . '/../../public/demo_documents/';
+    
+    protected array $codeExampleText;
 
     /**
      * Save the current operation so it will be resumed after authentication
@@ -39,6 +43,16 @@ protected function isHomePage(string $eg): bool
         return in_array($eg, ["home_esig", "home_rooms", "home_click", "home_monitor", "home_admin"]);
     }
 
+    protected function getPageText(string $eg): array
+    {
+        return ManifestService::getPageText($eg);
+    }
+
+    protected function getCommonText(): array
+    {
+        return ManifestService::getCommonTexts();
+    }
+
     protected function homePageTitle($eg=''): string
     {
         $title = '';

src/Controllers/ClickApiBaseController.php

@@ -29,6 +29,8 @@ abstract function getTemplateArgs(): array;
      */
     public function controller(array $args = null): void
     {
+        $this->codeExampleText = $this->getPageText(static::EG);
+        
         $method = $_SERVER['REQUEST_METHOD'];
         if ($method == 'GET') {
             $this->getController($this->routerService, basename(static::FILE), $args);
@@ -57,19 +59,21 @@ private function getController(
                 static::EG . '.html',
                 [
                     'title' => $this->homePageTitle(static::EG),
-                    'show_doc' => false
+                    'show_doc' => false,
+                    'common_texts' => $this->getCommonText()
                 ]
             );
         } else {
-            if ($routerService->ds_token_ok()) {
-
+            if ($routerService->ds_token_ok()) {              
                 $GLOBALS['twig']->display($routerService->getTemplate(static::EG), [
                     'title' => $routerService->getTitle(static::EG),
                     'source_file' => $basename,
                     'source_url' => $GLOBALS['DS_CONFIG']['github_example_url']  . "/Click/" . $basename,
                     'documentation' => $GLOBALS['DS_CONFIG']['documentation'] . static::EG,
                     'show_doc' => $GLOBALS['DS_CONFIG']['documentation'],
                     'args' => $args,
+                    'code_example_text' => $this->codeExampleText,
+                    'common_texts' => $this->getCommonText()
                 ]);
             }
             else {

src/Controllers/Examples/Admin/EG002CreateActiveCLMESignUser.php

@@ -47,6 +47,11 @@ public function __construct()
             $dsgReq = $this->clientService->adminGroupsApi();
             $dsgRes = $dsgReq->getDSGroups($this->orgId, $this->args["account_id"]);
             $dsGroups = $dsgRes["ds_groups"];
+            if ($dsgRes["ds_groups"] == null) {
+                throw new ApiException(
+                    $this->codeExampleText["CustomErrorTexts"][0]["ErrorMessage"]
+                );
+            }
             // Step 4 end
 
             $preFill = [
@@ -88,10 +93,8 @@ public function createController(): void
             $_SESSION['email_address'] = strval($addUsersResponse->getEmail());
 
             $addUsersResponse = json_decode((string)$addUsersResponse, true);
-            $this->clientService->showDoneTemplate(
-                "Create a new active user for CLM and eSignature",
-                "Create a new active user for CLM and eSignature",
-                "Results from MultiProductUserManagement:addOrUpdateUser method:",
+            $this->clientService->showDoneTemplateFromManifest(
+                $this->codeExampleText,
                 json_encode(json_encode($addUsersResponse))
             );
         }