Zm-Server.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  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_Server
  71. </h2>
  72. <aside class="phpdocumentor-element-found-in">
  73. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  74. :
  75. <span class="phpdocumentor-element-found-in__line">27</span>
  76. </aside>
  77. <p class="phpdocumentor-summary">Zm_Server is a class which allows to manage Kerio servers via SOAP</p>
  78. <section class="phpdocumentor-description"><p>You may create, modify, rename, delete and get the attributes of a Kerio server 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-Server.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-Server.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-Server.html#method_createServer">createServer()</a>
  100. <span>
  101. &nbsp;: array&lt;string|int, mixed&gt; </span>
  102. </dt>
  103. <dd>createServer</dd>
  104. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  105. <a href="classes/Zm-Server.html#method_deleteServer">deleteServer()</a>
  106. <span>
  107. &nbsp;: array&lt;string|int, mixed&gt; </span>
  108. </dt>
  109. <dd>deleteServer</dd>
  110. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  111. <a href="classes/Zm-Server.html#method_getAllServers">getAllServers()</a>
  112. <span>
  113. &nbsp;: array&lt;string|int, mixed&gt; </span>
  114. </dt>
  115. <dd>getAllServers</dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  117. <a href="classes/Zm-Server.html#method_getServerId">getServerId()</a>
  118. <span>
  119. &nbsp;: string </span>
  120. </dt>
  121. <dd>getServerId</dd>
  122. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  123. <a href="classes/Zm-Server.html#method_getServerOptions">getServerOptions()</a>
  124. <span>
  125. &nbsp;: array&lt;string|int, mixed&gt; </span>
  126. </dt>
  127. <dd>getServerOptions</dd>
  128. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  129. <a href="classes/Zm-Server.html#method_modifyServer">modifyServer()</a>
  130. <span>
  131. &nbsp;: array&lt;string|int, mixed&gt; </span>
  132. </dt>
  133. <dd>modifyServer</dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  135. <a href="classes/Zm-Server.html#method_serverExists">serverExists()</a>
  136. <span>
  137. &nbsp;: bool </span>
  138. </dt>
  139. <dd>serverExists</dd>
  140. </dl>
  141. <section class="phpdocumentor-properties">
  142. <h3 class="phpdocumentor-elements__header" id="properties">
  143. Properties
  144. <a href="classes/Zm-Server.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  145. </h3>
  146. <article
  147. class="
  148. phpdocumentor-element
  149. -property
  150. -private
  151. "
  152. >
  153. <h4 class="phpdocumentor-element__name" id="property_auth">
  154. $auth
  155. <a href="classes/Zm-Server.html#property_auth" class="headerlink"><i class="fas fa-link"></i></a>
  156. <span class="phpdocumentor-element__modifiers">
  157. </span>
  158. </h4>
  159. <aside class="phpdocumentor-element-found-in">
  160. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  161. :
  162. <span class="phpdocumentor-element-found-in__line">33</span>
  163. </aside>
  164. <p class="phpdocumentor-summary">$auth</p>
  165. <code class="phpdocumentor-code phpdocumentor-signature ">
  166. <span class="phpdocumentor-signature__visibility">private</span>
  167. <span class="phpdocumentor-signature__type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  168. <span class="phpdocumentor-signature__name">$auth</span>
  169. </code>
  170. <section class="phpdocumentor-description"></section>
  171. </article>
  172. </section>
  173. <section class="phpdocumentor-methods">
  174. <h3 class="phpdocumentor-elements__header" id="methods">
  175. Methods
  176. <a href="classes/Zm-Server.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  177. </h3>
  178. <article
  179. class="phpdocumentor-element
  180. -method
  181. -public
  182. "
  183. >
  184. <h4 class="phpdocumentor-element__name" id="method___construct">
  185. __construct()
  186. <a href="classes/Zm-Server.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  187. </h4>
  188. <aside class="phpdocumentor-element-found-in">
  189. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  190. :
  191. <span class="phpdocumentor-element-found-in__line">39</span>
  192. </aside>
  193. <p class="phpdocumentor-summary">Constructor</p>
  194. <code class="phpdocumentor-code phpdocumentor-signature ">
  195. <span class="phpdocumentor-signature__visibility">public</span>
  196. <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>
  197. <section class="phpdocumentor-description"></section>
  198. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  199. <dl class="phpdocumentor-argument-list">
  200. <dt class="phpdocumentor-argument-list__entry">
  201. <span class="phpdocumentor-signature__argument__name">$auth</span>
  202. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Zm-Auth.html"><abbr title="\Zm_Auth">Zm_Auth</abbr></a></span>
  203. </dt>
  204. <dd class="phpdocumentor-argument-list__definition">
  205. <section class="phpdocumentor-description"><p>soap authentication</p>
  206. </section>
  207. </dd>
  208. </dl>
  209. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  210. <span class="phpdocumentor-signature__response_type">mixed</span>
  211. &mdash;
  212. <section class="phpdocumentor-description"></section>
  213. </article>
  214. <article
  215. class="phpdocumentor-element
  216. -method
  217. -public
  218. "
  219. >
  220. <h4 class="phpdocumentor-element__name" id="method_createServer">
  221. createServer()
  222. <a href="classes/Zm-Server.html#method_createServer" class="headerlink"><i class="fas fa-link"></i></a>
  223. </h4>
  224. <aside class="phpdocumentor-element-found-in">
  225. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  226. :
  227. <span class="phpdocumentor-element-found-in__line">177</span>
  228. </aside>
  229. <p class="phpdocumentor-summary">createServer</p>
  230. <code class="phpdocumentor-code phpdocumentor-signature ">
  231. <span class="phpdocumentor-signature__visibility">public</span>
  232. <span class="phpdocumentor-signature__name">createServer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</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">$attrs</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>
  233. <section class="phpdocumentor-description"></section>
  234. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  235. <dl class="phpdocumentor-argument-list">
  236. <dt class="phpdocumentor-argument-list__entry">
  237. <span class="phpdocumentor-signature__argument__name">$name</span>
  238. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  239. </dt>
  240. <dd class="phpdocumentor-argument-list__definition">
  241. <section class="phpdocumentor-description"><p>a server name</p>
  242. </section>
  243. </dd>
  244. <dt class="phpdocumentor-argument-list__entry">
  245. <span class="phpdocumentor-signature__argument__name">$attrs</span>
  246. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  247. = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
  248. <dd class="phpdocumentor-argument-list__definition">
  249. <section class="phpdocumentor-description"><p>an optional array containing the server attributes to be set</p>
  250. </section>
  251. </dd>
  252. </dl>
  253. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  254. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  255. &mdash;
  256. <section class="phpdocumentor-description"><p>an array with the new server's info</p>
  257. </section>
  258. </article>
  259. <article
  260. class="phpdocumentor-element
  261. -method
  262. -public
  263. "
  264. >
  265. <h4 class="phpdocumentor-element__name" id="method_deleteServer">
  266. deleteServer()
  267. <a href="classes/Zm-Server.html#method_deleteServer" class="headerlink"><i class="fas fa-link"></i></a>
  268. </h4>
  269. <aside class="phpdocumentor-element-found-in">
  270. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  271. :
  272. <span class="phpdocumentor-element-found-in__line">253</span>
  273. </aside>
  274. <p class="phpdocumentor-summary">deleteServer</p>
  275. <code class="phpdocumentor-code phpdocumentor-signature ">
  276. <span class="phpdocumentor-signature__visibility">public</span>
  277. <span class="phpdocumentor-signature__name">deleteServer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameServer</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  278. <section class="phpdocumentor-description"></section>
  279. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  280. <dl class="phpdocumentor-argument-list">
  281. <dt class="phpdocumentor-argument-list__entry">
  282. <span class="phpdocumentor-signature__argument__name">$idOrNameServer</span>
  283. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  284. </dt>
  285. <dd class="phpdocumentor-argument-list__definition">
  286. <section class="phpdocumentor-description"><p>server id or server name</p>
  287. </section>
  288. </dd>
  289. <dt class="phpdocumentor-argument-list__entry">
  290. <span class="phpdocumentor-signature__argument__name">$type</span>
  291. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  292. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  293. <dd class="phpdocumentor-argument-list__definition">
  294. <section class="phpdocumentor-description"><p>value of the server (auto, name, id)</p>
  295. </section>
  296. </dd>
  297. </dl>
  298. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  299. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  300. &mdash;
  301. <section class="phpdocumentor-description"><p>informations</p>
  302. </section>
  303. </article>
  304. <article
  305. class="phpdocumentor-element
  306. -method
  307. -public
  308. "
  309. >
  310. <h4 class="phpdocumentor-element__name" id="method_getAllServers">
  311. getAllServers()
  312. <a href="classes/Zm-Server.html#method_getAllServers" class="headerlink"><i class="fas fa-link"></i></a>
  313. </h4>
  314. <aside class="phpdocumentor-element-found-in">
  315. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  316. :
  317. <span class="phpdocumentor-element-found-in__line">49</span>
  318. </aside>
  319. <p class="phpdocumentor-summary">getAllServers</p>
  320. <code class="phpdocumentor-code phpdocumentor-signature ">
  321. <span class="phpdocumentor-signature__visibility">public</span>
  322. <span class="phpdocumentor-signature__name">getAllServers</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  323. <section class="phpdocumentor-description"></section>
  324. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  325. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  326. &mdash;
  327. <section class="phpdocumentor-description"><p>informations</p>
  328. </section>
  329. </article>
  330. <article
  331. class="phpdocumentor-element
  332. -method
  333. -public
  334. "
  335. >
  336. <h4 class="phpdocumentor-element__name" id="method_getServerId">
  337. getServerId()
  338. <a href="classes/Zm-Server.html#method_getServerId" class="headerlink"><i class="fas fa-link"></i></a>
  339. </h4>
  340. <aside class="phpdocumentor-element-found-in">
  341. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  342. :
  343. <span class="phpdocumentor-element-found-in__line">72</span>
  344. </aside>
  345. <p class="phpdocumentor-summary">getServerId</p>
  346. <code class="phpdocumentor-code phpdocumentor-signature ">
  347. <span class="phpdocumentor-signature__visibility">public</span>
  348. <span class="phpdocumentor-signature__name">getServerId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  349. <section class="phpdocumentor-description"></section>
  350. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  351. <dl class="phpdocumentor-argument-list">
  352. <dt class="phpdocumentor-argument-list__entry">
  353. <span class="phpdocumentor-signature__argument__name">$name</span>
  354. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  355. </dt>
  356. <dd class="phpdocumentor-argument-list__definition">
  357. <section class="phpdocumentor-description"><p>a server name</p>
  358. </section>
  359. </dd>
  360. </dl>
  361. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  362. <span class="phpdocumentor-signature__response_type">string</span>
  363. &mdash;
  364. <section class="phpdocumentor-description"><p>a server id</p>
  365. </section>
  366. </article>
  367. <article
  368. class="phpdocumentor-element
  369. -method
  370. -public
  371. "
  372. >
  373. <h4 class="phpdocumentor-element__name" id="method_getServerOptions">
  374. getServerOptions()
  375. <a href="classes/Zm-Server.html#method_getServerOptions" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h4>
  377. <aside class="phpdocumentor-element-found-in">
  378. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  379. :
  380. <span class="phpdocumentor-element-found-in__line">137</span>
  381. </aside>
  382. <p class="phpdocumentor-summary">getServerOptions</p>
  383. <code class="phpdocumentor-code phpdocumentor-signature ">
  384. <span class="phpdocumentor-signature__visibility">public</span>
  385. <span class="phpdocumentor-signature__name">getServerOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameServer</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  386. <section class="phpdocumentor-description"></section>
  387. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  388. <dl class="phpdocumentor-argument-list">
  389. <dt class="phpdocumentor-argument-list__entry">
  390. <span class="phpdocumentor-signature__argument__name">$idOrNameServer</span>
  391. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  392. </dt>
  393. <dd class="phpdocumentor-argument-list__definition">
  394. <section class="phpdocumentor-description"><p>server id or server name</p>
  395. </section>
  396. </dd>
  397. <dt class="phpdocumentor-argument-list__entry">
  398. <span class="phpdocumentor-signature__argument__name">$type</span>
  399. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  400. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  401. <dd class="phpdocumentor-argument-list__definition">
  402. <section class="phpdocumentor-description"><p>value of the server (auto, name, id)</p>
  403. </section>
  404. </dd>
  405. </dl>
  406. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  407. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  408. &mdash;
  409. <section class="phpdocumentor-description"></section>
  410. </article>
  411. <article
  412. class="phpdocumentor-element
  413. -method
  414. -public
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="method_modifyServer">
  418. modifyServer()
  419. <a href="classes/Zm-Server.html#method_modifyServer" class="headerlink"><i class="fas fa-link"></i></a>
  420. </h4>
  421. <aside class="phpdocumentor-element-found-in">
  422. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  423. :
  424. <span class="phpdocumentor-element-found-in__line">212</span>
  425. </aside>
  426. <p class="phpdocumentor-summary">modifyServer</p>
  427. <code class="phpdocumentor-code phpdocumentor-signature ">
  428. <span class="phpdocumentor-signature__visibility">public</span>
  429. <span class="phpdocumentor-signature__name">modifyServer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameServer</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">$attrs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  430. <section class="phpdocumentor-description"></section>
  431. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  432. <dl class="phpdocumentor-argument-list">
  433. <dt class="phpdocumentor-argument-list__entry">
  434. <span class="phpdocumentor-signature__argument__name">$idOrNameServer</span>
  435. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  436. </dt>
  437. <dd class="phpdocumentor-argument-list__definition">
  438. <section class="phpdocumentor-description"><p>server id or server name</p>
  439. </section>
  440. </dd>
  441. <dt class="phpdocumentor-argument-list__entry">
  442. <span class="phpdocumentor-signature__argument__name">$attrs</span>
  443. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  444. = <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
  445. <dd class="phpdocumentor-argument-list__definition">
  446. <section class="phpdocumentor-description"><p>an array containing the server attributes to be set</p>
  447. </section>
  448. </dd>
  449. <dt class="phpdocumentor-argument-list__entry">
  450. <span class="phpdocumentor-signature__argument__name">$type</span>
  451. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  452. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  453. <dd class="phpdocumentor-argument-list__definition">
  454. <section class="phpdocumentor-description"><p>value of the server (auto, name, id)</p>
  455. </section>
  456. </dd>
  457. </dl>
  458. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  459. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  460. &mdash;
  461. <section class="phpdocumentor-description"><p>informations</p>
  462. </section>
  463. </article>
  464. <article
  465. class="phpdocumentor-element
  466. -method
  467. -public
  468. "
  469. >
  470. <h4 class="phpdocumentor-element__name" id="method_serverExists">
  471. serverExists()
  472. <a href="classes/Zm-Server.html#method_serverExists" class="headerlink"><i class="fas fa-link"></i></a>
  473. </h4>
  474. <aside class="phpdocumentor-element-found-in">
  475. <abbr class="phpdocumentor-element-found-in__file" title="Zm/Server.php"><a href="files/zm-server.html"><abbr title="Zm/Server.php">Server.php</abbr></a></abbr>
  476. :
  477. <span class="phpdocumentor-element-found-in__line">103</span>
  478. </aside>
  479. <p class="phpdocumentor-summary">serverExists</p>
  480. <code class="phpdocumentor-code phpdocumentor-signature ">
  481. <span class="phpdocumentor-signature__visibility">public</span>
  482. <span class="phpdocumentor-signature__name">serverExists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$idOrNameServer</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  483. <section class="phpdocumentor-description"></section>
  484. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  485. <dl class="phpdocumentor-argument-list">
  486. <dt class="phpdocumentor-argument-list__entry">
  487. <span class="phpdocumentor-signature__argument__name">$idOrNameServer</span>
  488. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  489. </dt>
  490. <dd class="phpdocumentor-argument-list__definition">
  491. <section class="phpdocumentor-description"><p>server id or server name</p>
  492. </section>
  493. </dd>
  494. <dt class="phpdocumentor-argument-list__entry">
  495. <span class="phpdocumentor-signature__argument__name">$type</span>
  496. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  497. = <span class="phpdocumentor-signature__argument__default-value">&quot;auto&quot;</span> </dt>
  498. <dd class="phpdocumentor-argument-list__definition">
  499. <section class="phpdocumentor-description"><p>value of the server (auto, name, id)</p>
  500. </section>
  501. </dd>
  502. </dl>
  503. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  504. <span class="phpdocumentor-signature__response_type">bool</span>
  505. &mdash;
  506. <section class="phpdocumentor-description"><p>exists</p>
  507. </section>
  508. </article>
  509. </section>
  510. </article>
  511. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  512. <section class="phpdocumentor-search-results__dialog">
  513. <header class="phpdocumentor-search-results__header">
  514. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  515. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  516. </header>
  517. <section class="phpdocumentor-search-results__body">
  518. <ul class="phpdocumentor-search-results__entries"></ul>
  519. </section>
  520. </section>
  521. </section>
  522. </div>
  523. </div>
  524. <a href="classes/Zm-Server.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  525. </main>
  526. <script>
  527. cssVars({});
  528. </script>
  529. </body>
  530. </html>