Bladeren bron

update doc

andre 5 jaren geleden
bovenliggende
commit
2ca7856aad
5 gewijzigde bestanden met toevoegingen van 273 en 28 verwijderingen
  1. 67 7
      Doc/files/zimbrasingle.html
  2. 67 7
      Doc/index.html
  3. 5 0
      Doc/js/searchIndex.js
  4. 67 7
      Doc/namespaces/default.html
  5. 67 7
      Doc/packages/Default.html

+ 67 - 7
Doc/files/zimbrasingle.html

@@ -177,6 +177,13 @@
 </dt>
 <dd>Define Zimbra product configuration options.</dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -function -">
+    <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn">zimbraSingle_ServiceSingleSignOn()</a>
+    <span>
+                        &nbsp;: array&lt;string|int, mixed&gt;    </span>
+</dt>
+<dd>Perform single sign-on for a given instance of a product/service.</dd>
+
     </dl>
 
 
@@ -501,7 +508,7 @@ Run Manually: /admin/reports.php?report=disk_usage_summary&amp;action=updatestat
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">299</span>
+    <span class="phpdocumentor-element-found-in__line">301</span>
 </aside>
 
         <p class="phpdocumentor-summary">Change the password for a Zimbra account.</p>
@@ -557,7 +564,7 @@ active status.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">347</span>
+    <span class="phpdocumentor-element-found-in__line">349</span>
 </aside>
 
         <p class="phpdocumentor-summary">Provision a new instance of a Zimbra account.</p>
@@ -616,7 +623,7 @@ configuration, this can be any of:</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">451</span>
+    <span class="phpdocumentor-element-found-in__line">453</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status locked.</p>
@@ -670,7 +677,7 @@ user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">492</span>
+    <span class="phpdocumentor-element-found-in__line">494</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status active.</p>
@@ -724,7 +731,7 @@ can be called manually by admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">532</span>
+    <span class="phpdocumentor-element-found-in__line">534</span>
 </aside>
 
         <p class="phpdocumentor-summary">Removes a Zimbra account.</p>
@@ -777,7 +784,7 @@ overdue products if enabled, or requested manually by an admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">590</span>
+    <span class="phpdocumentor-element-found-in__line">592</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a new class of service for a Zimbra account.</p>
@@ -833,7 +840,7 @@ products and configurable options.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">656</span>
+    <span class="phpdocumentor-element-found-in__line">658</span>
 </aside>
 
         <p class="phpdocumentor-summary">Define Zimbra product configuration options.</p>
@@ -875,6 +882,59 @@ Calls a function to create all necessary customfields for the order form using t
                         </dl>
 
     
+</article>
+                    <article class="phpdocumentor-element -function - ">
+    <h4 class="phpdocumentor-element__name" id="function_zimbraSingle_ServiceSingleSignOn">
+        zimbraSingle_ServiceSingleSignOn()
+        <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn" class="headerlink"><i class="fas fa-link"></i></a>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">735</span>
+</aside>
+
+        <p class="phpdocumentor-summary">Perform single sign-on for a given instance of a product/service.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility"></span>
+                <span class="phpdocumentor-signature__name">zimbraSingle_ServiceSingleSignOn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
+
+        <section class="phpdocumentor-description"><p>Called when single sign-on is requested for an instance of a product/service.</p>
+<p>When successful, returns an URL to which the user should be redirected.</p>
+</section>
+
+        <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
+    <dl class="phpdocumentor-argument-list">
+                    <dt class="phpdocumentor-argument-list__entry">
+                <span class="phpdocumentor-signature__argument__name">$params</span>
+                : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
+                            </dt>
+            <dd class="phpdocumentor-argument-list__definition">
+                    <section class="phpdocumentor-description"><p>common module parameters</p>
+</section>
+
+            </dd>
+            </dl>
+
+    
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">see</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                                    <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
+                                        
+                                                 <section class="phpdocumentor-description"></section>
+
+                                    </dd>
+                        </dl>
+
+    
 </article>
             </section>
 

+ 67 - 7
Doc/index.html

@@ -173,6 +173,13 @@
 </dt>
 <dd>Define Zimbra product configuration options.</dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -function -">
+    <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn">zimbraSingle_ServiceSingleSignOn()</a>
+    <span>
+                        &nbsp;: array&lt;string|int, mixed&gt;    </span>
+</dt>
+<dd>Perform single sign-on for a given instance of a product/service.</dd>
+
     </dl>
 
     
@@ -496,7 +503,7 @@ Run Manually: /admin/reports.php?report=disk_usage_summary&amp;action=updatestat
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">299</span>
+    <span class="phpdocumentor-element-found-in__line">301</span>
 </aside>
 
         <p class="phpdocumentor-summary">Change the password for a Zimbra account.</p>
@@ -552,7 +559,7 @@ active status.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">347</span>
+    <span class="phpdocumentor-element-found-in__line">349</span>
 </aside>
 
         <p class="phpdocumentor-summary">Provision a new instance of a Zimbra account.</p>
@@ -611,7 +618,7 @@ configuration, this can be any of:</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">451</span>
+    <span class="phpdocumentor-element-found-in__line">453</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status locked.</p>
@@ -665,7 +672,7 @@ user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">492</span>
+    <span class="phpdocumentor-element-found-in__line">494</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status active.</p>
@@ -719,7 +726,7 @@ can be called manually by admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">532</span>
+    <span class="phpdocumentor-element-found-in__line">534</span>
 </aside>
 
         <p class="phpdocumentor-summary">Removes a Zimbra account.</p>
@@ -772,7 +779,7 @@ overdue products if enabled, or requested manually by an admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">590</span>
+    <span class="phpdocumentor-element-found-in__line">592</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a new class of service for a Zimbra account.</p>
@@ -828,7 +835,7 @@ products and configurable options.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">656</span>
+    <span class="phpdocumentor-element-found-in__line">658</span>
 </aside>
 
         <p class="phpdocumentor-summary">Define Zimbra product configuration options.</p>
@@ -870,6 +877,59 @@ Calls a function to create all necessary customfields for the order form using t
                         </dl>
 
     
+</article>
+                    <article class="phpdocumentor-element -function - ">
+    <h4 class="phpdocumentor-element__name" id="function_zimbraSingle_ServiceSingleSignOn">
+        zimbraSingle_ServiceSingleSignOn()
+        <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn" class="headerlink"><i class="fas fa-link"></i></a>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">735</span>
+</aside>
+
+        <p class="phpdocumentor-summary">Perform single sign-on for a given instance of a product/service.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility"></span>
+                <span class="phpdocumentor-signature__name">zimbraSingle_ServiceSingleSignOn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
+
+        <section class="phpdocumentor-description"><p>Called when single sign-on is requested for an instance of a product/service.</p>
+<p>When successful, returns an URL to which the user should be redirected.</p>
+</section>
+
+        <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
+    <dl class="phpdocumentor-argument-list">
+                    <dt class="phpdocumentor-argument-list__entry">
+                <span class="phpdocumentor-signature__argument__name">$params</span>
+                : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
+                            </dt>
+            <dd class="phpdocumentor-argument-list__definition">
+                    <section class="phpdocumentor-description"><p>common module parameters</p>
+</section>
+
+            </dd>
+            </dl>
+
+    
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">see</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                                    <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
+                                        
+                                                 <section class="phpdocumentor-description"></section>
+
+                                    </dd>
+                        </dl>
+
+    
 </article>
             </section>
 

+ 5 - 0
Doc/js/searchIndex.js

@@ -65,6 +65,11 @@ Search.appendIndex(
             "name": "zimbraSingle_ConfigOptions",
             "summary": "Define\u0020Zimbra\u0020product\u0020configuration\u0020options.",
             "url": "namespaces/default.html#function_zimbraSingle_ConfigOptions"
+        },                {
+            "fqsen": "\\zimbraSingle_ServiceSingleSignOn\u0028\u0029",
+            "name": "zimbraSingle_ServiceSingleSignOn",
+            "summary": "Perform\u0020single\u0020sign\u002Don\u0020for\u0020a\u0020given\u0020instance\u0020of\u0020a\u0020product\/service.",
+            "url": "namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn"
         },                {
             "fqsen": "\\",
             "name": "\\",

+ 67 - 7
Doc/namespaces/default.html

@@ -176,6 +176,13 @@
 </dt>
 <dd>Define Zimbra product configuration options.</dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -function -">
+    <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn">zimbraSingle_ServiceSingleSignOn()</a>
+    <span>
+                        &nbsp;: array&lt;string|int, mixed&gt;    </span>
+</dt>
+<dd>Perform single sign-on for a given instance of a product/service.</dd>
+
     </dl>
 
         
@@ -499,7 +506,7 @@ Run Manually: /admin/reports.php?report=disk_usage_summary&amp;action=updatestat
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">299</span>
+    <span class="phpdocumentor-element-found-in__line">301</span>
 </aside>
 
         <p class="phpdocumentor-summary">Change the password for a Zimbra account.</p>
@@ -555,7 +562,7 @@ active status.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">347</span>
+    <span class="phpdocumentor-element-found-in__line">349</span>
 </aside>
 
         <p class="phpdocumentor-summary">Provision a new instance of a Zimbra account.</p>
@@ -614,7 +621,7 @@ configuration, this can be any of:</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">451</span>
+    <span class="phpdocumentor-element-found-in__line">453</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status locked.</p>
@@ -668,7 +675,7 @@ user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">492</span>
+    <span class="phpdocumentor-element-found-in__line">494</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status active.</p>
@@ -722,7 +729,7 @@ can be called manually by admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">532</span>
+    <span class="phpdocumentor-element-found-in__line">534</span>
 </aside>
 
         <p class="phpdocumentor-summary">Removes a Zimbra account.</p>
@@ -775,7 +782,7 @@ overdue products if enabled, or requested manually by an admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">590</span>
+    <span class="phpdocumentor-element-found-in__line">592</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a new class of service for a Zimbra account.</p>
@@ -831,7 +838,7 @@ products and configurable options.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">656</span>
+    <span class="phpdocumentor-element-found-in__line">658</span>
 </aside>
 
         <p class="phpdocumentor-summary">Define Zimbra product configuration options.</p>
@@ -873,6 +880,59 @@ Calls a function to create all necessary customfields for the order form using t
                         </dl>
 
     
+</article>
+                    <article class="phpdocumentor-element -function - ">
+    <h4 class="phpdocumentor-element__name" id="function_zimbraSingle_ServiceSingleSignOn">
+        zimbraSingle_ServiceSingleSignOn()
+        <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn" class="headerlink"><i class="fas fa-link"></i></a>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">735</span>
+</aside>
+
+        <p class="phpdocumentor-summary">Perform single sign-on for a given instance of a product/service.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility"></span>
+                <span class="phpdocumentor-signature__name">zimbraSingle_ServiceSingleSignOn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
+
+        <section class="phpdocumentor-description"><p>Called when single sign-on is requested for an instance of a product/service.</p>
+<p>When successful, returns an URL to which the user should be redirected.</p>
+</section>
+
+        <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
+    <dl class="phpdocumentor-argument-list">
+                    <dt class="phpdocumentor-argument-list__entry">
+                <span class="phpdocumentor-signature__argument__name">$params</span>
+                : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
+                            </dt>
+            <dd class="phpdocumentor-argument-list__definition">
+                    <section class="phpdocumentor-description"><p>common module parameters</p>
+</section>
+
+            </dd>
+            </dl>
+
+    
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">see</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                                    <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
+                                        
+                                                 <section class="phpdocumentor-description"></section>
+
+                                    </dd>
+                        </dl>
+
+    
 </article>
             </section>
 

+ 67 - 7
Doc/packages/Default.html

@@ -176,6 +176,13 @@
 </dt>
 <dd>Define Zimbra product configuration options.</dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -function -">
+    <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn">zimbraSingle_ServiceSingleSignOn()</a>
+    <span>
+                        &nbsp;: array&lt;string|int, mixed&gt;    </span>
+</dt>
+<dd>Perform single sign-on for a given instance of a product/service.</dd>
+
     </dl>
 
         
@@ -499,7 +506,7 @@ Run Manually: /admin/reports.php?report=disk_usage_summary&amp;action=updatestat
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">299</span>
+    <span class="phpdocumentor-element-found-in__line">301</span>
 </aside>
 
         <p class="phpdocumentor-summary">Change the password for a Zimbra account.</p>
@@ -555,7 +562,7 @@ active status.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">347</span>
+    <span class="phpdocumentor-element-found-in__line">349</span>
 </aside>
 
         <p class="phpdocumentor-summary">Provision a new instance of a Zimbra account.</p>
@@ -614,7 +621,7 @@ configuration, this can be any of:</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">451</span>
+    <span class="phpdocumentor-element-found-in__line">453</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status locked.</p>
@@ -668,7 +675,7 @@ user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">492</span>
+    <span class="phpdocumentor-element-found-in__line">494</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a Zimbra account to status active.</p>
@@ -722,7 +729,7 @@ can be called manually by admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">532</span>
+    <span class="phpdocumentor-element-found-in__line">534</span>
 </aside>
 
         <p class="phpdocumentor-summary">Removes a Zimbra account.</p>
@@ -775,7 +782,7 @@ overdue products if enabled, or requested manually by an admin user.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">590</span>
+    <span class="phpdocumentor-element-found-in__line">592</span>
 </aside>
 
         <p class="phpdocumentor-summary">Set a new class of service for a Zimbra account.</p>
@@ -831,7 +838,7 @@ products and configurable options.</p>
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">656</span>
+    <span class="phpdocumentor-element-found-in__line">658</span>
 </aside>
 
         <p class="phpdocumentor-summary">Define Zimbra product configuration options.</p>
@@ -873,6 +880,59 @@ Calls a function to create all necessary customfields for the order form using t
                         </dl>
 
     
+</article>
+                    <article class="phpdocumentor-element -function - ">
+    <h4 class="phpdocumentor-element__name" id="function_zimbraSingle_ServiceSingleSignOn">
+        zimbraSingle_ServiceSingleSignOn()
+        <a href="namespaces/default.html#function_zimbraSingle_ServiceSingleSignOn" class="headerlink"><i class="fas fa-link"></i></a>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="zimbraSingle.php"><a href="files/zimbrasingle.html"><abbr title="zimbraSingle.php">zimbraSingle.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">735</span>
+</aside>
+
+        <p class="phpdocumentor-summary">Perform single sign-on for a given instance of a product/service.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility"></span>
+                <span class="phpdocumentor-signature__name">zimbraSingle_ServiceSingleSignOn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
+
+        <section class="phpdocumentor-description"><p>Called when single sign-on is requested for an instance of a product/service.</p>
+<p>When successful, returns an URL to which the user should be redirected.</p>
+</section>
+
+        <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
+    <dl class="phpdocumentor-argument-list">
+                    <dt class="phpdocumentor-argument-list__entry">
+                <span class="phpdocumentor-signature__argument__name">$params</span>
+                : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
+                            </dt>
+            <dd class="phpdocumentor-argument-list__definition">
+                    <section class="phpdocumentor-description"><p>common module parameters</p>
+</section>
+
+            </dd>
+            </dl>
+
+    
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">see</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                                    <span class="phpdocumentor-tag-link"><a href="https://developers.whmcs.com/provisioning-modules/module-parameters/"><abbr title="https://developers.whmcs.com/provisioning-modules/module-parameters/">https://developers.whmcs.com/provisioning-modules/module-parameters/</abbr></a></span>
+                                        
+                                                 <section class="phpdocumentor-description"></section>
+
+                                    </dd>
+                        </dl>
+
+    
 </article>
             </section>