Zm-User.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  12. <link rel="stylesheet" href="css/template.css">
  13. <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" />
  14. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  15. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  16. <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
  17. <script src="js/search.js"></script>
  18. <script defer src="js/searchIndex.js"></script>
  19. </head>
  20. <body id="top">
  21. <header class="phpdocumentor-header phpdocumentor-section">
  22. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  23. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  24. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  25. <i class="fas fa-bars"></i>
  26. </label>
  27. <section data-search-form class="phpdocumentor-search">
  28. <label>
  29. <span class="visually-hidden">Search for</span>
  30. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  31. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  32. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  33. </svg>
  34. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  35. </label>
  36. </section>
  37. <nav class="phpdocumentor-topnav">
  38. <ul class="phpdocumentor-topnav__menu">
  39. </ul>
  40. </nav>
  41. </header>
  42. <main class="phpdocumentor">
  43. <div class="phpdocumentor-section">
  44. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  45. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  46. Menu
  47. </label>
  48. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  49. <section class="phpdocumentor-sidebar__category">
  50. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  51. <h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
  52. </section>
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  55. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  56. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  57. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  58. </section>
  59. <section class="phpdocumentor-sidebar__category">
  60. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  61. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  62. </section>
  63. </aside>
  64. <div class="phpdocumentor-column -eight phpdocumentor-content">
  65. <ul class="phpdocumentor-breadcrumbs">
  66. <li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
  67. </ul>
  68. <article class="phpdocumentor-element -class">
  69. <h2 class="phpdocumentor-content__title">
  70. Zm_User
  71. </h2>
  72. <aside class="phpdocumentor-element-found-in">
  73. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  74. :
  75. <span class="phpdocumentor-element-found-in__line">27</span>
  76. </aside>
  77. <p class="phpdocumentor-summary">Zm_User is a class which allows a Kerio user to manage its own account via SOAP</p>
  78. <section class="phpdocumentor-description"><p>You may change password, modify and get the attributes of a Kerio user using this class</p>
  79. <p>For the usage examples of all class methods check the source code of test.php</p>
  80. </section>
  81. <h3 id="toc">
  82. Table of Contents
  83. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  84. </h3>
  85. <dl class="phpdocumentor-table-of-contents">
  86. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  87. <a href="classes/Zm-User.html#property_auth">$auth</a>
  88. <span>
  89. &nbsp;: <a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a> </span>
  90. </dt>
  91. <dd>$auth</dd>
  92. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  93. <a href="classes/Zm-User.html#method___construct">__construct()</a>
  94. <span>
  95. &nbsp;: mixed </span>
  96. </dt>
  97. <dd>Constructor</dd>
  98. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  99. <a href="classes/Zm-User.html#method_changeUserPassword">changeUserPassword()</a>
  100. <span>
  101. &nbsp;: array&lt;string|int, mixed&gt; </span>
  102. </dt>
  103. <dd>changeUserPassword</dd>
  104. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  105. <a href="classes/Zm-User.html#method_getUserAttrs">getUserAttrs()</a>
  106. <span>
  107. &nbsp;: string </span>
  108. </dt>
  109. <dd>getUserAttrs</dd>
  110. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  111. <a href="classes/Zm-User.html#method_getUserInfo">getUserInfo()</a>
  112. <span>
  113. &nbsp;: array&lt;string|int, mixed&gt; </span>
  114. </dt>
  115. <dd>getUserInfo</dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  117. <a href="classes/Zm-User.html#method_getUserPrefs">getUserPrefs()</a>
  118. <span>
  119. &nbsp;: array&lt;string|int, mixed&gt; </span>
  120. </dt>
  121. <dd>getUserPrefs</dd>
  122. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  123. <a href="classes/Zm-User.html#method_modifyUserPrefs">modifyUserPrefs()</a>
  124. <span>
  125. &nbsp;: array&lt;string|int, mixed&gt; </span>
  126. </dt>
  127. <dd>modifyUserPrefs</dd>
  128. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  129. <a href="classes/Zm-User.html#method_userExists">userExists()</a>
  130. <span>
  131. &nbsp;: bool </span>
  132. </dt>
  133. <dd>userExists</dd>
  134. </dl>
  135. <section class="phpdocumentor-properties">
  136. <h3 class="phpdocumentor-elements__header" id="properties">
  137. Properties
  138. <a href="classes/Zm-User.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h3>
  140. <article
  141. class="
  142. phpdocumentor-element
  143. -property
  144. -private
  145. "
  146. >
  147. <h4 class="phpdocumentor-element__name" id="property_auth">
  148. $auth
  149. <a href="classes/Zm-User.html#property_auth" class="headerlink"><i class="fas fa-link"></i></a>
  150. <span class="phpdocumentor-element__modifiers">
  151. </span>
  152. </h4>
  153. <aside class="phpdocumentor-element-found-in">
  154. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  155. :
  156. <span class="phpdocumentor-element-found-in__line">33</span>
  157. </aside>
  158. <p class="phpdocumentor-summary">$auth</p>
  159. <code class="phpdocumentor-code phpdocumentor-signature ">
  160. <span class="phpdocumentor-signature__visibility">private</span>
  161. <span class="phpdocumentor-signature__type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  162. <span class="phpdocumentor-signature__name">$auth</span>
  163. </code>
  164. <section class="phpdocumentor-description"></section>
  165. </article>
  166. </section>
  167. <section class="phpdocumentor-methods">
  168. <h3 class="phpdocumentor-elements__header" id="methods">
  169. Methods
  170. <a href="classes/Zm-User.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  171. </h3>
  172. <article
  173. class="phpdocumentor-element
  174. -method
  175. -public
  176. "
  177. >
  178. <h4 class="phpdocumentor-element__name" id="method___construct">
  179. __construct()
  180. <a href="classes/Zm-User.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  181. </h4>
  182. <aside class="phpdocumentor-element-found-in">
  183. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  184. :
  185. <span class="phpdocumentor-element-found-in__line">39</span>
  186. </aside>
  187. <p class="phpdocumentor-summary">Constructor</p>
  188. <code class="phpdocumentor-code phpdocumentor-signature ">
  189. <span class="phpdocumentor-signature__visibility">public</span>
  190. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$auth</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  191. <section class="phpdocumentor-description"></section>
  192. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  193. <dl class="phpdocumentor-argument-list">
  194. <dt class="phpdocumentor-argument-list__entry">
  195. <span class="phpdocumentor-signature__argument__name">$auth</span>
  196. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  197. </dt>
  198. <dd class="phpdocumentor-argument-list__definition">
  199. <section class="phpdocumentor-description"><p>soap authentication</p>
  200. </section>
  201. </dd>
  202. </dl>
  203. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  204. <span class="phpdocumentor-signature__response_type">mixed</span>
  205. &mdash;
  206. <section class="phpdocumentor-description"></section>
  207. </article>
  208. <article
  209. class="phpdocumentor-element
  210. -method
  211. -public
  212. "
  213. >
  214. <h4 class="phpdocumentor-element__name" id="method_changeUserPassword">
  215. changeUserPassword()
  216. <a href="classes/Zm-User.html#method_changeUserPassword" class="headerlink"><i class="fas fa-link"></i></a>
  217. </h4>
  218. <aside class="phpdocumentor-element-found-in">
  219. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  220. :
  221. <span class="phpdocumentor-element-found-in__line">181</span>
  222. </aside>
  223. <p class="phpdocumentor-summary">changeUserPassword</p>
  224. <code class="phpdocumentor-code phpdocumentor-signature ">
  225. <span class="phpdocumentor-signature__visibility">public</span>
  226. <span class="phpdocumentor-signature__name">changeUserPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$oldPassword</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$newPassword</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  227. <section class="phpdocumentor-description"></section>
  228. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  229. <dl class="phpdocumentor-argument-list">
  230. <dt class="phpdocumentor-argument-list__entry">
  231. <span class="phpdocumentor-signature__argument__name">$userName</span>
  232. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  233. </dt>
  234. <dd class="phpdocumentor-argument-list__definition">
  235. <section class="phpdocumentor-description"><p>user name</p>
  236. </section>
  237. </dd>
  238. <dt class="phpdocumentor-argument-list__entry">
  239. <span class="phpdocumentor-signature__argument__name">$oldPassword</span>
  240. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  241. </dt>
  242. <dd class="phpdocumentor-argument-list__definition">
  243. <section class="phpdocumentor-description"><p>old password</p>
  244. </section>
  245. </dd>
  246. <dt class="phpdocumentor-argument-list__entry">
  247. <span class="phpdocumentor-signature__argument__name">$newPassword</span>
  248. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  249. </dt>
  250. <dd class="phpdocumentor-argument-list__definition">
  251. <section class="phpdocumentor-description"><p>new password</p>
  252. </section>
  253. </dd>
  254. </dl>
  255. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  256. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  257. &mdash;
  258. <section class="phpdocumentor-description"><p>informations</p>
  259. </section>
  260. </article>
  261. <article
  262. class="phpdocumentor-element
  263. -method
  264. -public
  265. "
  266. >
  267. <h4 class="phpdocumentor-element__name" id="method_getUserAttrs">
  268. getUserAttrs()
  269. <a href="classes/Zm-User.html#method_getUserAttrs" class="headerlink"><i class="fas fa-link"></i></a>
  270. </h4>
  271. <aside class="phpdocumentor-element-found-in">
  272. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  273. :
  274. <span class="phpdocumentor-element-found-in__line">110</span>
  275. </aside>
  276. <p class="phpdocumentor-summary">getUserAttrs</p>
  277. <code class="phpdocumentor-code phpdocumentor-signature ">
  278. <span class="phpdocumentor-signature__visibility">public</span>
  279. <span class="phpdocumentor-signature__name">getUserAttrs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  280. <section class="phpdocumentor-description"></section>
  281. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  282. <dl class="phpdocumentor-argument-list">
  283. <dt class="phpdocumentor-argument-list__entry">
  284. <span class="phpdocumentor-signature__argument__name">$userName</span>
  285. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  286. </dt>
  287. <dd class="phpdocumentor-argument-list__definition">
  288. <section class="phpdocumentor-description"><p>user name</p>
  289. </section>
  290. </dd>
  291. </dl>
  292. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  293. <span class="phpdocumentor-signature__response_type">string</span>
  294. &mdash;
  295. <section class="phpdocumentor-description"><p>option</p>
  296. </section>
  297. </article>
  298. <article
  299. class="phpdocumentor-element
  300. -method
  301. -public
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="method_getUserInfo">
  305. getUserInfo()
  306. <a href="classes/Zm-User.html#method_getUserInfo" class="headerlink"><i class="fas fa-link"></i></a>
  307. </h4>
  308. <aside class="phpdocumentor-element-found-in">
  309. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  310. :
  311. <span class="phpdocumentor-element-found-in__line">82</span>
  312. </aside>
  313. <p class="phpdocumentor-summary">getUserInfo</p>
  314. <code class="phpdocumentor-code phpdocumentor-signature ">
  315. <span class="phpdocumentor-signature__visibility">public</span>
  316. <span class="phpdocumentor-signature__name">getUserInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  317. <section class="phpdocumentor-description"></section>
  318. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  319. <dl class="phpdocumentor-argument-list">
  320. <dt class="phpdocumentor-argument-list__entry">
  321. <span class="phpdocumentor-signature__argument__name">$userName</span>
  322. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  323. </dt>
  324. <dd class="phpdocumentor-argument-list__definition">
  325. <section class="phpdocumentor-description"><p>user name</p>
  326. </section>
  327. </dd>
  328. </dl>
  329. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  330. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  331. &mdash;
  332. <section class="phpdocumentor-description"><p>informations</p>
  333. </section>
  334. </article>
  335. <article
  336. class="phpdocumentor-element
  337. -method
  338. -public
  339. "
  340. >
  341. <h4 class="phpdocumentor-element__name" id="method_getUserPrefs">
  342. getUserPrefs()
  343. <a href="classes/Zm-User.html#method_getUserPrefs" class="headerlink"><i class="fas fa-link"></i></a>
  344. </h4>
  345. <aside class="phpdocumentor-element-found-in">
  346. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  347. :
  348. <span class="phpdocumentor-element-found-in__line">145</span>
  349. </aside>
  350. <p class="phpdocumentor-summary">getUserPrefs</p>
  351. <code class="phpdocumentor-code phpdocumentor-signature ">
  352. <span class="phpdocumentor-signature__visibility">public</span>
  353. <span class="phpdocumentor-signature__name">getUserPrefs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  354. <section class="phpdocumentor-description"></section>
  355. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  356. <dl class="phpdocumentor-argument-list">
  357. <dt class="phpdocumentor-argument-list__entry">
  358. <span class="phpdocumentor-signature__argument__name">$userName</span>
  359. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  360. </dt>
  361. <dd class="phpdocumentor-argument-list__definition">
  362. <section class="phpdocumentor-description"><p>user name</p>
  363. </section>
  364. </dd>
  365. </dl>
  366. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  367. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  368. &mdash;
  369. <section class="phpdocumentor-description"><p>prefs</p>
  370. </section>
  371. </article>
  372. <article
  373. class="phpdocumentor-element
  374. -method
  375. -public
  376. "
  377. >
  378. <h4 class="phpdocumentor-element__name" id="method_modifyUserPrefs">
  379. modifyUserPrefs()
  380. <a href="classes/Zm-User.html#method_modifyUserPrefs" class="headerlink"><i class="fas fa-link"></i></a>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">214</span>
  386. </aside>
  387. <p class="phpdocumentor-summary">modifyUserPrefs</p>
  388. <code class="phpdocumentor-code phpdocumentor-signature ">
  389. <span class="phpdocumentor-signature__visibility">public</span>
  390. <span class="phpdocumentor-signature__name">modifyUserPrefs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$prefs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  391. <section class="phpdocumentor-description"></section>
  392. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  393. <dl class="phpdocumentor-argument-list">
  394. <dt class="phpdocumentor-argument-list__entry">
  395. <span class="phpdocumentor-signature__argument__name">$userName</span>
  396. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  397. </dt>
  398. <dd class="phpdocumentor-argument-list__definition">
  399. <section class="phpdocumentor-description"><p>user name</p>
  400. </section>
  401. </dd>
  402. <dt class="phpdocumentor-argument-list__entry">
  403. <span class="phpdocumentor-signature__argument__name">$prefs</span>
  404. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  405. = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
  406. <dd class="phpdocumentor-argument-list__definition">
  407. <section class="phpdocumentor-description"><p>an array containing the user prefs to be set</p>
  408. </section>
  409. </dd>
  410. </dl>
  411. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  412. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  413. &mdash;
  414. <section class="phpdocumentor-description"><p>informations</p>
  415. </section>
  416. </article>
  417. <article
  418. class="phpdocumentor-element
  419. -method
  420. -public
  421. "
  422. >
  423. <h4 class="phpdocumentor-element__name" id="method_userExists">
  424. userExists()
  425. <a href="classes/Zm-User.html#method_userExists" class="headerlink"><i class="fas fa-link"></i></a>
  426. </h4>
  427. <aside class="phpdocumentor-element-found-in">
  428. <abbr class="phpdocumentor-element-found-in__file" title="Zm/User.php"><a href="files/zm-user.html"><abbr title="Zm/User.php">User.php</abbr></a></abbr>
  429. :
  430. <span class="phpdocumentor-element-found-in__line">50</span>
  431. </aside>
  432. <p class="phpdocumentor-summary">userExists</p>
  433. <code class="phpdocumentor-code phpdocumentor-signature ">
  434. <span class="phpdocumentor-signature__visibility">public</span>
  435. <span class="phpdocumentor-signature__name">userExists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$userName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  436. <section class="phpdocumentor-description"></section>
  437. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  438. <dl class="phpdocumentor-argument-list">
  439. <dt class="phpdocumentor-argument-list__entry">
  440. <span class="phpdocumentor-signature__argument__name">$userName</span>
  441. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  442. </dt>
  443. <dd class="phpdocumentor-argument-list__definition">
  444. <section class="phpdocumentor-description"><p>user name</p>
  445. </section>
  446. </dd>
  447. </dl>
  448. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  449. <span class="phpdocumentor-signature__response_type">bool</span>
  450. &mdash;
  451. <section class="phpdocumentor-description"><p>exists</p>
  452. </section>
  453. </article>
  454. </section>
  455. </article>
  456. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  457. <section class="phpdocumentor-search-results__dialog">
  458. <header class="phpdocumentor-search-results__header">
  459. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  460. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  461. </header>
  462. <section class="phpdocumentor-search-results__body">
  463. <ul class="phpdocumentor-search-results__entries"></ul>
  464. </section>
  465. </section>
  466. </section>
  467. </div>
  468. </div>
  469. <a href="classes/Zm-User.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  470. </main>
  471. <script>
  472. cssVars({});
  473. </script>
  474. </body>
  475. </html>