|
|
@@ -0,0 +1,1040 @@
|
|
|
+<!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 -class">
|
|
|
+ <h2 class="phpdocumentor-content__title">
|
|
|
+ Sf_Admin
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </h2>
|
|
|
+
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">21</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Sf_Admin is a class which allows to manage Seafile accounts via web-api/v2.1-admin</p>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>You may create, modify, migrate, delete and get the attributes of a Seafile account using this class</p>
|
|
|
+<p>For the usage examples of all class methods check the source code of test.php</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<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 -property -protected">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfToken">$sfToken</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_constructorSuccess">$constructorSuccess</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_loginSuccess">$loginSuccess</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfAdminName">$sfAdminName</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfConType">$sfConType</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfPassword">$sfPassword</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfPort">$sfPort</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfSecure">$sfSecure</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfURL">$sfURL</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method___construct">__construct()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd>Constructor</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_constructorSuccess">constructorSuccess()</a>
|
|
|
+ <span>
|
|
|
+ : mixed </span>
|
|
|
+</dt>
|
|
|
+<dd></dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_createAccount">createAccount()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>getAccount</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_deleteAccount">deleteAccount()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>deleteAccount</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_getAccount">getAccount()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>getAccount</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_getAllAccounts">getAllAccounts()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>getAllAccounts</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_login">login()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>login</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_loginSuccess">loginSuccess()</a>
|
|
|
+ <span>
|
|
|
+ : bool </span>
|
|
|
+</dt>
|
|
|
+<dd>loginSuccess</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_migrateAccount">migrateAccount()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>migrateAccount</dd>
|
|
|
+
|
|
|
+ <dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
+ <a href="classes/Sf-Admin.html#method_modifyAccount">modifyAccount()</a>
|
|
|
+ <span>
|
|
|
+ : array<string|int, mixed> </span>
|
|
|
+</dt>
|
|
|
+<dd>modifyAccount</dd>
|
|
|
+
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <section class="phpdocumentor-properties">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="properties">
|
|
|
+ Properties
|
|
|
+ <a href="classes/Sf-Admin.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h3>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -protected
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfToken">
|
|
|
+ $sfToken
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfToken" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">30</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfToken</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_constructorSuccess">
|
|
|
+ $constructorSuccess
|
|
|
+ <a href="classes/Sf-Admin.html#property_constructorSuccess" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">23</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$constructorSuccess</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_loginSuccess">
|
|
|
+ $loginSuccess
|
|
|
+ <a href="classes/Sf-Admin.html#property_loginSuccess" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">22</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$loginSuccess</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfAdminName">
|
|
|
+ $sfAdminName
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfAdminName" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">28</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfAdminName</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfConType">
|
|
|
+ $sfConType
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfConType" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">25</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfConType</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfPassword">
|
|
|
+ $sfPassword
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfPassword" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">29</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfPassword</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfPort">
|
|
|
+ $sfPort
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfPort" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">26</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfPort</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfSecure">
|
|
|
+ $sfSecure
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfSecure" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">27</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfSecure</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="
|
|
|
+ phpdocumentor-element
|
|
|
+ -property
|
|
|
+ -private
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="property_sfURL">
|
|
|
+ $sfURL
|
|
|
+ <a href="classes/Sf-Admin.html#property_sfURL" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ <span class="phpdocumentor-element__modifiers">
|
|
|
+ </span>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">24</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">private</span>
|
|
|
+ <span class="phpdocumentor-signature__type">mixed</span>
|
|
|
+ <span class="phpdocumentor-signature__name">$sfURL</span>
|
|
|
+ </code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ </section>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-methods">
|
|
|
+ <h3 class="phpdocumentor-elements__header" id="methods">
|
|
|
+ Methods
|
|
|
+ <a href="classes/Sf-Admin.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h3>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method___construct">
|
|
|
+ __construct()
|
|
|
+ <a href="classes/Sf-Admin.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">38</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">Constructor</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$seafileURL</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$username</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$password</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$secure</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></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">$seafileURL</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>Seafile URL (example: https://seafile.my.lan)</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$username</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>admin/user account's e-mail</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$password</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>admin/user account's password</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$secure</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ = <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>optional false to force unsecure (default true)</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">mixed</span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_constructorSuccess">
|
|
|
+ constructorSuccess()
|
|
|
+ <a href="classes/Sf-Admin.html#method_constructorSuccess" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">72</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">constructorSuccess</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">mixed</span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_createAccount">
|
|
|
+ createAccount()
|
|
|
+ <a href="classes/Sf-Admin.html#method_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="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">188</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">getAccount</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">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">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></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>avvount informations, email required.</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://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User"><abbr title="https://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User">https://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User</abbr></a></span>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>of account informations or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_deleteAccount">
|
|
|
+ deleteAccount()
|
|
|
+ <a href="classes/Sf-Admin.html#method_deleteAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">261</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">deleteAccount</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">deleteAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$email</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-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$email</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>login e-mail</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>success => true or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getAccount">
|
|
|
+ getAccount()
|
|
|
+ <a href="classes/Sf-Admin.html#method_getAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">157</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">getAccount</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$email</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-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$email</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>login e-mail</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>of account informations or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_getAllAccounts">
|
|
|
+ getAllAccounts()
|
|
|
+ <a href="classes/Sf-Admin.html#method_getAllAccounts" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">128</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">getAllAccounts</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">getAllAccounts</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-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>of seafile accounts array of informations or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_login">
|
|
|
+ login()
|
|
|
+ <a href="classes/Sf-Admin.html#method_login" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">81</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">login</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">login</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"><p>fetch and set seafile lofin token</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>error or true</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_loginSuccess">
|
|
|
+ loginSuccess()
|
|
|
+ <a href="classes/Sf-Admin.html#method_loginSuccess" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">120</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">loginSuccess</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">loginSuccess</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_migrateAccount">
|
|
|
+ migrateAccount()
|
|
|
+ <a href="classes/Sf-Admin.html#method_migrateAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">296</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">migrateAccount</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">migrateAccount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$from</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$to</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-argument-list__heading">Parameters</h5>
|
|
|
+ <dl class="phpdocumentor-argument-list">
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$from</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>source account login e-mail</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ <dt class="phpdocumentor-argument-list__entry">
|
|
|
+ <span class="phpdocumentor-signature__argument__name">$to</span>
|
|
|
+ : <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
+ </dt>
|
|
|
+ <dd class="phpdocumentor-argument-list__definition">
|
|
|
+ <section class="phpdocumentor-description"><p>destination account login e-mail (must exist)</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>success => true or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</article>
|
|
|
+ <article
|
|
|
+ class="phpdocumentor-element
|
|
|
+ -method
|
|
|
+ -public
|
|
|
+ "
|
|
|
+>
|
|
|
+ <h4 class="phpdocumentor-element__name" id="method_modifyAccount">
|
|
|
+ modifyAccount()
|
|
|
+ <a href="classes/Sf-Admin.html#method_modifyAccount" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
+ </h4>
|
|
|
+ <aside class="phpdocumentor-element-found-in">
|
|
|
+ <abbr class="phpdocumentor-element-found-in__file" title="Admin.php"><a href="files/admin.html"><abbr title="Admin.php">Admin.php</abbr></a></abbr>
|
|
|
+ :
|
|
|
+ <span class="phpdocumentor-element-found-in__line">224</span>
|
|
|
+</aside>
|
|
|
+
|
|
|
+ <p class="phpdocumentor-summary">modifyAccount</p>
|
|
|
+
|
|
|
+ <code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
+ <span class="phpdocumentor-signature__visibility">public</span>
|
|
|
+ <span class="phpdocumentor-signature__name">modifyAccount</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"></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>avvount informations, email required.</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://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User"><abbr title="https://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User">https://download.seafile.com/published/web-api/v2.1-admin/accounts.md#user-content-Add%20User</abbr></a></span>
|
|
|
+
|
|
|
+ <section class="phpdocumentor-description"></section>
|
|
|
+
|
|
|
+ </dd>
|
|
|
+ </dl>
|
|
|
+
|
|
|
+ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
+ <span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
+ —
|
|
|
+ <section class="phpdocumentor-description"><p>of account informations or error message</p>
|
|
|
+</section>
|
|
|
+
|
|
|
+
|
|
|
+</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="classes/Sf-Admin.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
+
|
|
|
+ </main>
|
|
|
+
|
|
|
+ <script>
|
|
|
+ cssVars({});
|
|
|
+ </script>
|
|
|
+</body>
|
|
|
+</html>
|
andre
