|
|
@@ -0,0 +1,820 @@
|
|
|
+<!DOCTYPE html>
|
|
|
+<html lang="en">
|
|
|
+<head>
|
|
|
+ <meta charset="utf-8">
|
|
|
+ <title>Documentation</title>
|
|
|
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
+ <base href="../">
|
|
|
+ <link rel="icon" href="images/favicon.ico"/>
|
|
|
+ <link rel="stylesheet" href="css/normalize.css">
|
|
|
+ <link rel="stylesheet" href="css/base.css">
|
|
|
+ <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
|
+ <link rel="stylesheet" href="css/template.css">
|
|
|
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
|
+ <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
|
+ <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
|
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
|
|
|
+ <script src="js/search.js"></script>
|
|
|
+ <script defer src="js/searchIndex.js"></script>
|
|
|
+ </head>
|
|
|
+<body id="top">
|
|
|
+ <header class="phpdocumentor-header phpdocumentor-section">
|
|
|
+ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
|
+ <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
|
+ <label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
|
+ <i class="fas fa-bars"></i>
|
|
|
+ </label>
|
|
|
+ <section data-search-form class="phpdocumentor-search">
|
|
|
+ <label>
|
|
|
+ <span class="visually-hidden">Search for</span>
|
|
|
+ <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
|
+ <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
|
+ <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
|
+ </svg>
|
|
|
+ <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
|
+ </label>
|
|
|
+</section>
|
|
|
+
|
|
|
+ <nav class="phpdocumentor-topnav">
|
|
|
+ <ul class="phpdocumentor-topnav__menu">
|
|
|
+ </ul>
|
|
|
+</nav>
|
|
|
+</header>
|
|
|
+
|
|
|
+ <main class="phpdocumentor">
|
|
|
+ <div class="phpdocumentor-section">
|
|
|
+ <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
|
+<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
|
+ Menu
|
|
|
+</label>
|
|
|
+<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
|
|
+
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
|
+ <h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
|
|
|
+ </section>
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
|
+ <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
|
+ <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
|
+ <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
|
+ </section>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-sidebar__category">
|
|
|
+ <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
|
+ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
|
+ </section>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
|
+ <ul class="phpdocumentor-breadcrumbs">
|
|
|
+ <li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
|
|
|
+ </ul>
|
|
|
+
|
|
|
+ <article class="phpdocumentor-element -file">
|
|
|
+ <h2 class="phpdocumentor-content__title">seafile.php</h2>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<h3 id="toc">
|
|
|
+ Table of Contents
|
|
|
+ <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+</h3>
|
|
|
+
|
|
|
+<dl class="phpdocumentor-table-of-contents">
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_MetaData">seafile_MetaData()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_ConfigOptions">seafile_ConfigOptions()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>Define SeaFile product configuration options.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_TestConnection">seafile_TestConnection()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>Test connection to a SeaFile server with the given server parameters.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_UsageUpdate">seafile_UsageUpdate()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Usage Update</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_ClientArea">seafile_ClientArea()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>Client area output logic handling.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_ChangePassword">seafile_ChangePassword()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Change the password for a SeaFile account.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_ChangePackage">seafile_ChangePackage()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Set a new quota of a SeaFile account.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_CreateAccount">seafile_CreateAccount()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Provision a new instance of a SeaFile account.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_SuspendAccount">seafile_SuspendAccount()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Set a SeaFile account to status inactive.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_UnsuspendAccount">seafile_UnsuspendAccount()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Set a SeaFile account to status active.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafile_TerminateAccount">seafile_TerminateAccount()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>Removes a SeaFile account.</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
+ <a href="namespaces/default.html#function_seafileCheckPassword">seafileCheckPassword()</a>
|
|
|
+ <span>
|
|
|
+ : string </span>
|
|
|
+</dt>
|
|
|
+<dd>server side password check</dd>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-functions">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="functions">
|
|
|
+ Functions
|
|
|
+ <a href="files/seafile.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h3>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_MetaData">
|
|
|
+ seafile_MetaData()
|
|
|
+ <a href="namespaces/default.html#function_seafile_MetaData" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">18</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_MetaData</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_ConfigOptions">
|
|
|
+ seafile_ConfigOptions()
|
|
|
+ <a href="namespaces/default.html#function_seafile_ConfigOptions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">40</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Define SeaFile product configuration options.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_ConfigOptions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <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/config-options/"><abbr title="https://developers.whmcs.com/provisioning-modules/config-options/">https://developers.whmcs.com/provisioning-modules/config-options/</abbr></a></span>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_TestConnection">
|
|
|
+ seafile_TestConnection()
|
|
|
+ <a href="namespaces/default.html#function_seafile_TestConnection" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">70</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Test connection to a SeaFile server with the given server parameters.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_TestConnection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Allows an admin user to verify that an API connection can be
|
|
|
+successfully made with the given configuration parameters for a
|
|
|
+server.</p>
|
|
|
+<p>When defined in a module, a Test Connection button will appear
|
|
|
+alongside the Server Type dropdown when adding or editing an
|
|
|
+existing server.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_UsageUpdate">
|
|
|
+ seafile_UsageUpdate()
|
|
|
+ <a href="namespaces/default.html#function_seafile_UsageUpdate" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">101</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Usage Update</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_UsageUpdate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Important: Runs daily per server not per product
|
|
|
+Run Manually: /admin/reports.php?report=disk_usage_summary&action=updatestats</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<string|int, mixed></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/usage-update/"><abbr title="https://developers.whmcs.com/provisioning-modules/usage-update/">https://developers.whmcs.com/provisioning-modules/usage-update/</abbr></a></span>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_ClientArea">
|
|
|
+ seafile_ClientArea()
|
|
|
+ <a href="namespaces/default.html#function_seafile_ClientArea" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">176</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Client area output logic handling.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_ClientArea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>This function is used to define module specific client area output. It should
|
|
|
+return an array consisting of a template file and optional additional
|
|
|
+template variables to make available to that template.</p>
|
|
|
+<p>The template file you return can be one of two types:</p>
|
|
|
+<ul>
|
|
|
+<li>
|
|
|
+<p>tabOverviewModuleOutputTemplate - The output of the template provided here
|
|
|
+will be displayed as part of the default product/service client area
|
|
|
+product overview page.</p>
|
|
|
+</li>
|
|
|
+<li>
|
|
|
+<p>tabOverviewReplacementTemplate - Alternatively using this option allows you
|
|
|
+to entirely take control of the product/service overview page within the
|
|
|
+client area.</p>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<p>Whichever option you choose, extra template variables are defined in the same
|
|
|
+way. This demonstrates the use of the full replacement.</p>
|
|
|
+<p>Please Note: Using tabOverviewReplacementTemplate means you should display
|
|
|
+the standard information such as pricing and billing details in your custom
|
|
|
+template or they will not be visible to the end user.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_ChangePassword">
|
|
|
+ seafile_ChangePassword()
|
|
|
+ <a href="namespaces/default.html#function_seafile_ChangePassword" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">239</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Change the password for a SeaFile account.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_ChangePassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Called when a password change is requested. This can occur either due to a
|
|
|
+client requesting it via the client area or an admin requesting it from the
|
|
|
+admin side.</p>
|
|
|
+<p>This option is only available to client end users when the product is in an
|
|
|
+active status.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_ChangePackage">
|
|
|
+ seafile_ChangePackage()
|
|
|
+ <a href="namespaces/default.html#function_seafile_ChangePackage" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">298</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Set a new quota of a SeaFile account.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_ChangePackage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Called to apply a quota change of the service. It
|
|
|
+is called to provision upgrade or downgrade orders, as well as being
|
|
|
+able to be invoked manually by an admin user.</p>
|
|
|
+<p>This same function is called for upgrades and downgrades of both
|
|
|
+products and configurable options.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_CreateAccount">
|
|
|
+ seafile_CreateAccount()
|
|
|
+ <a href="namespaces/default.html#function_seafile_CreateAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">374</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Provision a new instance of a SeaFile account.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_CreateAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Attempt to provision a new SeaFile account. This is
|
|
|
+called any time provisioning is requested inside of WHMCS. Depending upon the
|
|
|
+configuration, this can be any of:</p>
|
|
|
+<ul>
|
|
|
+<li>When a new order is placed</li>
|
|
|
+<li>When an invoice for a new order is paid</li>
|
|
|
+<li>Upon manual request by an admin user</li>
|
|
|
+</ul>
|
|
|
+</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_SuspendAccount">
|
|
|
+ seafile_SuspendAccount()
|
|
|
+ <a href="namespaces/default.html#function_seafile_SuspendAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">464</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Set a SeaFile account to status inactive.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_SuspendAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Called when a suspension is requested. This is invoked automatically by WHMCS
|
|
|
+when a product becomes overdue on payment or can be called manually by admin
|
|
|
+user.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_UnsuspendAccount">
|
|
|
+ seafile_UnsuspendAccount()
|
|
|
+ <a href="namespaces/default.html#function_seafile_UnsuspendAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">503</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Set a SeaFile account to status active.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_UnsuspendAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Called when an un-suspension is requested. This is invoked
|
|
|
+automatically upon payment of an overdue invoice for a product, or
|
|
|
+can be called manually by admin user.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafile_TerminateAccount">
|
|
|
+ seafile_TerminateAccount()
|
|
|
+ <a href="namespaces/default.html#function_seafile_TerminateAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">542</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Removes a SeaFile account.</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafile_TerminateAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>Called when a termination is requested. This can be invoked automatically for
|
|
|
+overdue products if enabled, or requested manually by an admin user.</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<string|int, mixed></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>
|
|
|
+ <article class="phpdocumentor-element -function - ">
|
|
|
+ <h4 class="phpdocumentor-element__name" id="function_seafileCheckPassword">
|
|
|
+ seafileCheckPassword()
|
|
|
+ <a href="namespaces/default.html#function_seafileCheckPassword" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="seafile.php"><a href="files/seafile.html"><abbr title="seafile.php">seafile.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">583</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">server side password check</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility"></span>
|
|
|
+ <span class="phpdocumentor-signature__name">seafileCheckPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$pwd</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>recheck the client side password check
|
|
|
+in case that the client side check has been disabled</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">$pwd</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>password</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+ </article>
|
|
|
+ <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
|
+ <section class="phpdocumentor-search-results__dialog">
|
|
|
+ <header class="phpdocumentor-search-results__header">
|
|
|
+ <h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
|
+ <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
|
+ </header>
|
|
|
+ <section class="phpdocumentor-search-results__body">
|
|
|
+ <ul class="phpdocumentor-search-results__entries"></ul>
|
|
|
+ </section>
|
|
|
+ </section>
|
|
|
+</section>
|
|
|
+ </div>
|
|
|
+ </div>
|
|
|
+ <a href="files/seafile.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
+
|
|
|
+ </main>
|
|
|
+
|
|
|
+ <script>
|
|
|
+ cssVars({});
|
|
|
+ </script>
|
|
|
+</body>
|
|
|
+</html>
|