Zend_Service_DeveloperGarden.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20221 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.service.developergarden">
  5. <title>Zend_Service_DeveloperGarden</title>
  6. <sect2 id="zend.service.developergarden.introduction">
  7. <title>Einführung in DeveloperGarden</title>
  8. <para>
  9. DeveloperGarden ist der Name für die &quot;Open Development services&quot; der Deutschen
  10. Telekom. Die &quot;Open Development services&quot; sind ein Set von
  11. <acronym>SOAP</acronym> API Services.
  12. </para>
  13. <para>
  14. Die Familie der <classname>Zend_Service_DeveloperGarden</classname> Komponenten bietet
  15. ein klares und einfaches Interface zur <ulink
  16. url="http://www.developergarden.com">DeveloperGarden API</ulink> und bietet
  17. zusätzlich Funktionalitäten um die Behandlung und Geschwindigkeit zu verbessern.
  18. </para>
  19. <itemizedlist>
  20. <listitem>
  21. <para>
  22. <link
  23. linkend="zend.service.developergarden.baseuserservice">BaseUserService</link>:
  24. Klasse um API Anteile sowie Details von Benutzerzugangsdaten zu managen.
  25. </para>
  26. </listitem>
  27. <listitem>
  28. <para>
  29. <link linkend="zend.service.developergarden.iplocation">IpLocation</link>:
  30. Lokalisiert die angegebene IP und gibt deren Geo Koordinaten zurück. Arbeitet
  31. nur mit IPs welche dem Netzwerk der deutschen Telekom zugeordnet sind.
  32. </para>
  33. </listitem>
  34. <listitem>
  35. <para>
  36. <link linkend="zend.service.developergarden.localsearch">LocalSearch</link>:
  37. Erlaubt die Suche mit Optionen in der Nähe oder um eine gegebene Geo Koordinate
  38. oder Stadt herum.
  39. </para>
  40. </listitem>
  41. <listitem>
  42. <para>
  43. <link linkend="zend.service.developergarden.sendsms">SendSms</link>: Sendet
  44. eine Sms oder Flash Sms zu einer gegebenen Nummer.
  45. </para>
  46. </listitem>
  47. <listitem>
  48. <para>
  49. <link linkend="zend.service.developergarden.smsvalidation">SmsValidation</link>:
  50. Prüft eine Nummer um Sie mit SendSms zu verwenden und auch um einen Rückkanal
  51. zu unterstützen.
  52. </para>
  53. </listitem>
  54. <listitem>
  55. <para>
  56. <link linkend="zend.service.developergarden.voicecall">VoiceCall</link>:
  57. Initiiert alle Anrufe zwischen zwei Nummern.
  58. </para>
  59. </listitem>
  60. <listitem>
  61. <para>
  62. <link
  63. linkend="zend.service.developergarden.conferencecall">ConferenceCall</link>:
  64. Man kann einen kompletten Konferenzraum mit Teilnehmern für eine AdHoc Konferenz
  65. konfigurieren oder auch eigene Konferenzen planen.
  66. </para>
  67. </listitem>
  68. </itemizedlist>
  69. <para>
  70. Die Backend SOAP API ist <ulink
  71. url="http://www.developergarden.com/openapi/dokumentation/">hier</ulink>
  72. dokumentiert.
  73. </para>
  74. <sect3 id="zend.service.developergarden.account">
  75. <title>Für einen Zugang anmelden</title>
  76. <para>
  77. Bevor man damit beginnen kann die DeveloperGarden API zu verwenden muss man sich
  78. erst für einen Zugang <ulink
  79. url="http://www.developergarden.com/register">anmelden</ulink>.
  80. </para>
  81. </sect3>
  82. <sect3 id="zend.service.developergarden.environment">
  83. <title>Die Umgebung</title>
  84. <para>
  85. Mit der DeveloperGarden API hat man die Möglichkeit zwischen 3 unterschiedlichen
  86. Umgebungen zu wählen mit denen gearbeitet werden kann.
  87. </para>
  88. <itemizedlist>
  89. <listitem>
  90. <para>
  91. <emphasis>production</emphasis>: In der Produktionsumgebung muss man für
  92. Anrufe, Sms und andere Bezahlservices zahlen.
  93. </para>
  94. </listitem>
  95. <listitem>
  96. <para>
  97. <emphasis>sandbox</emphasis>: Im Sandbox Modus kann man die selben Features,
  98. mit ein paar Einschränkungen, verwenden wir in der Produktion ohne für Sie
  99. zu zahlen. Normalerweise kann man die eigene Anwendung wärend der
  100. Entwicklung testen.
  101. </para>
  102. </listitem>
  103. <listitem>
  104. <para>
  105. <emphasis>mock</emphasis>: Die Mock Umgebung erlaubt es eigene Anwendungen
  106. zu bauen und Ergebnisse zu erhlaten ohne das irgendeine Aktion auf Seiten
  107. der API ausgelöst wird.
  108. </para>
  109. </listitem>
  110. </itemizedlist>
  111. <para>
  112. Für jede Umgebung und jedes Service sind einige spezielle Features (Optionen) zum
  113. Testen vorhanden. Sehen Sie bitte <ulink
  114. url="http://www.developergarden.com/openapi/dokumentation/">hier</ulink> nach
  115. Details.
  116. </para>
  117. </sect3>
  118. <sect3 id="zend.service.developergarden.config">
  119. <title>Your configuration</title>
  120. <para>
  121. Man kann allen Klassen ein Array an Konfigurationswerten übergeben. Mögliche Werte
  122. sind:
  123. </para>
  124. <itemizedlist>
  125. <listitem>
  126. <para>
  127. <emphasis>username</emphasis>: Der eigene Benutzername für die
  128. DeveloperGarden API.
  129. </para>
  130. </listitem>
  131. <listitem>
  132. <para>
  133. <emphasis>password</emphasis>: Das eigene Passwort für die DeveloperGarden
  134. API.
  135. </para>
  136. </listitem>
  137. <listitem>
  138. <para>
  139. <emphasis>environment</emphasis>: Die Umgebung welche man ausgewählt hat.
  140. </para>
  141. </listitem>
  142. </itemizedlist>
  143. <example id="zend.service.developergarden.config.example">
  144. <title>Konfigurationsbeispiel</title>
  145. <programlisting language="php"><![CDATA[
  146. require_once 'Zend/Service/DeveloperGarden/SendSms.php';
  147. $config = array(
  148. 'username' => 'meinBenutzername',
  149. 'password' => 'meinPasswort',
  150. 'environment' => Zend_Service_DeveloperGarden_SendSms::ENV_PRODUCTION,
  151. );
  152. $service = new Zend_Service_DeveloperGarden_SendSms($config);
  153. ]]></programlisting>
  154. </example>
  155. </sect3>
  156. </sect2>
  157. <sect2 id="zend.service.developergarden.baseuserservice">
  158. <title>BaseUserService</title>
  159. <para>
  160. Diese Klasse kann verwendet werden um Quotenwerte fpr die Services zu setzen und zu
  161. holen sowie um Accountdetails zu holen.
  162. </para>
  163. <para>
  164. Die Methode <methodname>getAccountBalance()</methodname> kann ein Array von Account Id's
  165. mit dem aktuellen Kontostatus (Credits) holen.
  166. </para>
  167. <example id="zend.service.developergarden.baseuserservice.getaccountbalance.example">
  168. <title>Beispiel zum Holen des Kontostatus</title>
  169. <programlisting language="php"><![CDATA[
  170. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  171. print_r($service->getAccountBalance());
  172. ]]></programlisting>
  173. </example>
  174. <sect3 id="zend.service.developergarden.baseuserservice.getquotainformation">
  175. <title>Holen von Quoteninformationen</title>
  176. <para>
  177. Man kann mit den angebotenen Methoden Quoteninformationen für ein spezifisches
  178. Servicemodul holen.
  179. </para>
  180. <example id="zend.service.developergarden.baseuserservice.getquotainformation.example">
  181. <title>Beispiel zum Holen der Quoteninformation</title>
  182. <programlisting language="php"><![CDATA[
  183. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  184. $result = $service->getSmsQuotaInformation(
  185. Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
  186. );
  187. echo 'Sms Quote:<br />';
  188. echo 'Max Quote: ', $result->getMaxQuota(), '<br />';
  189. echo 'Max Benutzer Quote: ', $result->getMaxUserQuota(), '<br />';
  190. echo 'Quotenlevel: ', $result->getQuotaLevel(), '<br />';
  191. ]]></programlisting>
  192. </example>
  193. <para>
  194. Man erhält ein <classname>Result</classname> Objekt welches alle Informationen
  195. enthält die man benötigt. Optional kann der
  196. <methodname>QuotaInformation</methodname> Methode die Umgebungskonstante übergeben
  197. werden um die Quote für eine spezifische Umgebung zu holen.
  198. </para>
  199. <para>
  200. Hier ist eine Liste aller <methodname>getQuotaInformation</methodname> Methoden:
  201. </para>
  202. <itemizedlist>
  203. <listitem>
  204. <para>
  205. <methodname>getConfernceCallQuotaInformation()</methodname>
  206. </para>
  207. </listitem>
  208. <listitem>
  209. <para>
  210. <methodname>getIPLocationQuotaInformation()</methodname>
  211. </para>
  212. </listitem>
  213. <listitem>
  214. <para>
  215. <methodname>getLocalSearchQuotaInformation()</methodname>
  216. </para>
  217. </listitem>
  218. <listitem>
  219. <para>
  220. <methodname>getSmsQuotaInformation()</methodname>
  221. </para>
  222. </listitem>
  223. <listitem>
  224. <para>
  225. <methodname>getVoiceCallQuotaInformation()</methodname>
  226. </para>
  227. </listitem>
  228. </itemizedlist>
  229. </sect3>
  230. <sect3 id="zend.service.developergarden.baseuserservice.changequotainformation">
  231. <title>Quoteninformationen ändern</title>
  232. <para>
  233. Um die aktuelle Quote zu ändern kann eine der
  234. <methodname>changeQuotaPool</methodname> Methoden verwendet werden. Der erste
  235. Parameter ist der neue Poolwert und der zweite ist die Umgebung.
  236. </para>
  237. <example
  238. id="zend.service.developergarden.baseuserservice.changequotainformation.example">
  239. <title>Beispiel zum Ändern der Quoteninformation</title>
  240. <programlisting language="php"><![CDATA[
  241. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  242. $result = $service->changeSmsQuotaPool(
  243. 1000,
  244. Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
  245. );
  246. if (!$result->hasError()) {
  247. echo 'updated Quota Pool';
  248. }
  249. ]]></programlisting>
  250. </example>
  251. <para>
  252. Hier ist eine Liste aller <methodname>changeQuotaPool</methodname> Methoden:
  253. </para>
  254. <itemizedlist>
  255. <listitem>
  256. <para>
  257. <methodname>changeConferenceCallQuotaPool()</methodname>
  258. </para>
  259. </listitem>
  260. <listitem>
  261. <para>
  262. <methodname>changeIPLocationQuotaPool()</methodname>
  263. </para>
  264. </listitem>
  265. <listitem>
  266. <para>
  267. <methodname>changeLocalSearchQuotaPool()</methodname>
  268. </para>
  269. </listitem>
  270. <listitem>
  271. <para>
  272. <methodname>changeSmsQuotaPool()</methodname>
  273. </para>
  274. </listitem>
  275. <listitem>
  276. <para>
  277. <methodname>changeVoiceCallQuotaPool()</methodname>
  278. </para>
  279. </listitem>
  280. </itemizedlist>
  281. </sect3>
  282. </sect2>
  283. <sect2 id="zend.service.developergarden.iplocation">
  284. <title>IP Lokalisierung</title>
  285. <para>
  286. Dieser Service erlaubt es Lokalisierungsinformationen für eine gegebene IP Adresse zu
  287. erhalten.
  288. </para>
  289. <para>
  290. Es gibt einige Einschränkungen:
  291. </para>
  292. <itemizedlist>
  293. <listitem>
  294. <para>Die IP Adresse muss im T-Home Netzwerk sein</para>
  295. </listitem>
  296. <listitem>
  297. <para>Nur die nächste größere Stadt wird aufgelöst</para>
  298. </listitem>
  299. <listitem>
  300. <para>IPv6 wird aktuell nicht unterstützt</para>
  301. </listitem>
  302. </itemizedlist>
  303. <example id="zend.service.developergarden.iplocation.locateip.example">
  304. <title>Eine gegebene IP lokalisieren</title>
  305. <programlisting language="php"><![CDATA[
  306. $service = new Zend_Service_DeveloperGarden_IpLocation($config);
  307. $service->setEnvironment(
  308. Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
  309. );
  310. $ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
  311. print_r($service->locateIp($ip));
  312. ]]></programlisting>
  313. </example>
  314. </sect2>
  315. <sect2 id="zend.service.developergarden.localsearch">
  316. <title>Lokalsuche</title>
  317. <para>
  318. Der Lokalsuch Service bietet die lokale Suchmaschine <ulink
  319. url="http://www.suchen.de">suchen.de</ulink> über ein Webservice Interface an. Für
  320. weitere Details wird auf <ulink
  321. url="http://www.developergarden.com/static/docu/en/ch04s02s06.html">die
  322. Dokumentation</ulink> verwiesen.
  323. </para>
  324. <example id="zend.service.developergarden.localsearch.example">
  325. <title>Ein Restaurant lokalisieren</title>
  326. <programlisting language="php"><![CDATA[
  327. $service = new Zend_Service_DeveloperGarden_LocalSearch($config);
  328. $search = new Zend_Service_DeveloperGarden_LocalSearch_SearchParameters();
  329. /**
  330. * @see http://www.developergarden.com/static/docu/en/ch04s02s06s04.html
  331. */
  332. $search->setWhat('pizza')
  333. ->setWhere('jena');
  334. print_r($service->localSearch($search));
  335. ]]></programlisting>
  336. </example>
  337. </sect2>
  338. <sect2 id="zend.service.developergarden.sendsms">
  339. <title>SMS senden</title>
  340. <para>
  341. Der SMS Versandservice wird verwendet um normale und Flash SMS zu beliebigen Nummern zu
  342. versenden.
  343. </para>
  344. <para>
  345. Die folgenden Einschränkungen sind auf die Verwendung des SMS Service anzuwenden:
  346. </para>
  347. <itemizedlist>
  348. <listitem>
  349. <para>
  350. Eine SMS oder Flash SMS darf in der Produktionsumgebung nicht länger als 765
  351. Zeichen sein und darf maximal an 10 Empfänger versendet werden.
  352. </para>
  353. </listitem>
  354. <listitem>
  355. <para>
  356. Eine SMS oder Flash SMS wird in der Sandboxumgebung gekürzt und mit einer Notiz
  357. in DeveloperGarden ausgestattet. Die maximale Länger der gesendeten Nachricht
  358. beträgt 160 Zeichen.
  359. </para>
  360. </listitem>
  361. <listitem>
  362. <para>
  363. In der Sandboxumgebug können maximal 10 SMS pro Tag versendet werden.
  364. </para>
  365. </listitem>
  366. <listitem>
  367. <para>
  368. Die folgenden Zeichen werden doppelt gezählt:
  369. <literal>| ^ € { } [ ] ~ \ LF</literal> (Zeilenumbruch)
  370. </para>
  371. </listitem>
  372. <listitem>
  373. <para>
  374. Wenn eine SMS oder Flash SMS länger als 160 Zeichen ist, wird immer für 153
  375. weitere Zeichen eine Nachricht berechnet (Quote und Kredit).
  376. </para>
  377. </listitem>
  378. <listitem>
  379. <para>
  380. Die Zustellung kann für SMS oder Flsh SMS bei Festnetzanschlüssen nicht
  381. garantiert werden.
  382. </para>
  383. </listitem>
  384. <listitem>
  385. <para>
  386. Der Sender darf maximal aus 11 Zeichen bestehen. Erlaubte Zeichen sind
  387. Buchstaben und Zahlen.
  388. </para>
  389. </listitem>
  390. <listitem>
  391. <para>
  392. Die Spezifikation einer Telefonnummer als Sender ist nur erlaubt wenn die
  393. Telefonnummer geprüft wurde. (Siehe <link
  394. linkend="zend.service.developergarden.smsvalidation">SMS Prüfung</link>)
  395. </para>
  396. </listitem>
  397. </itemizedlist>
  398. <example id="zend.service.developergarden.sendsms.example">
  399. <title>Senden einer SMS</title>
  400. <programlisting language="php"><![CDATA[
  401. $service = new Zend_Service_DeveloperGarden_SendSms($config);
  402. $sms = $service->createSms(
  403. '+49-172-123456; +49-177-789012',
  404. 'die Testnachricht',
  405. 'meinName'
  406. );
  407. print_r($service->send($sms));]]></programlisting>
  408. </example>
  409. </sect2>
  410. <sect2 id="zend.service.developergarden.smsvalidation">
  411. <title>SMS Prüfung</title>
  412. <para>
  413. Der SMS Prüfservice erlaubt die Prüfung einer physikalischen Telefonnummer um diese als
  414. Sender einer SMS zu verwenden.
  415. </para>
  416. <para>
  417. Zuerst muss <methodname>setValidationKeyword()</methodname> aufgerufen werden um eine
  418. SMS mit einem Schlüsselwort zu empfangen.
  419. </para>
  420. <para>
  421. Nachdem man sein Schlüsselwort erhalten hat, muss man
  422. <methodname>validate()</methodname> verwenden um die Nummer mit dem Schlüsselwort gegen
  423. das Service zu prüfen.
  424. </para>
  425. <para>
  426. Mit der Methode <methodname>getValidatedNumbers()</methodname> erhält man eine Liste
  427. aller bereits geprüften Nummern und den Status einer jeden.
  428. </para>
  429. <example id="zend.service.developergarden.smsvalidation.request.example">
  430. <title>Prüfschlüsselwörter anfragen</title>
  431. <programlisting language="php"><![CDATA[
  432. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  433. print_r($service->sendValidationKeyword('+49-172-123456'));
  434. ]]></programlisting>
  435. </example>
  436. <example id="zend.service.developergarden.smsvalidation.validate.example">
  437. <title>Eine Nummer mit einem Schlüsselwort prüfen</title>
  438. <programlisting language="php"><![CDATA[
  439. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  440. print_r($service->validate('DasSchlüsselWort', '+49-172-123456'));
  441. ]]></programlisting>
  442. </example>
  443. <para>
  444. Um eine geprüft Nummer als ungeprüft zu markieren muss die Methode
  445. <methodname>inValidate()</methodname> aufgerufen werden.
  446. </para>
  447. </sect2>
  448. <sect2 id="zend.service.developergarden.voicecall">
  449. <title>Sprachanruf</title>
  450. <para>
  451. Der Sprachanruf Service wird für das Setzen einer Sprachverbindung zwischen zwei
  452. Telefonverbindungen verwendet. Für spezifische Details lesen Sie bitte die <ulink
  453. url="http://www.developergarden.com/static/docu/en/ch04s02.html">API
  454. Dokumentation</ulink>.
  455. </para>
  456. <para>
  457. Normalerweise arbeitet der Service wie folgt:
  458. </para>
  459. <itemizedlist>
  460. <listitem>
  461. <para>
  462. Den ersten Teilnehmer anrufen.
  463. </para>
  464. </listitem>
  465. <listitem>
  466. <para>
  467. Wenn die Verbindung erfolgreich war, den zweiten Teilnehmer anrufen.
  468. </para>
  469. </listitem>
  470. <listitem>
  471. <para>
  472. Wenn der zweite Teilnehmer erfolgreich verbunden ist, werden beide Teilnehmer
  473. miteinander verbunden.
  474. </para>
  475. </listitem>
  476. <listitem>
  477. <para>
  478. Der Anruf bleibt geöffnet bis einer der Teilnehmer auflegt oder der
  479. Ablaufmechanismus eingreift.
  480. </para>
  481. </listitem>
  482. </itemizedlist>
  483. <example id="zend.service.developergarden.voicecall.call.example">
  484. <title>Zwei Nummern anrufen</title>
  485. <programlisting language="php"><![CDATA[
  486. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  487. $aNumber = '+49-30-000001';
  488. $bNumber = '+49-30-000002';
  489. $expiration = 30; // Sekunden
  490. $maxDuration = 300; // 5 Minuten
  491. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  492. echo $newCall->getSessionId();
  493. ]]></programlisting>
  494. </example>
  495. <para>
  496. Wenn der Anruf initiiert wurde, kann das Ergebnisobjekt nach der Session ID gefragt
  497. werden und diese Session ID für einen zusätzlichen Aufruf der Methoden
  498. <methodname>callStatus</methodname> oder <methodname>tearDownCall()</methodname>
  499. verwendet werden. Der zweite Parameter der Methode <methodname>callStatus()</methodname>
  500. erweitert die Ablaufzeit für diesen Anruf.
  501. </para>
  502. <example id="zend.service.developergarden.voicecall.teardown.example">
  503. <title>Zwei Nummern anrufen, den Status abfragen und Trennen</title>
  504. <programlisting language="php"><![CDATA[
  505. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  506. $aNumber = '+49-30-000001';
  507. $bNumber = '+49-30-000002';
  508. $expiration = 30; // Sekunden
  509. $maxDuration = 300; // 5 Minuten
  510. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  511. $sessionId = $newCall->getSessionId();
  512. $service->callStatus($sessionId, true); // Den Anruf verlängern
  513. sleep(10); // 10s schlummern und dann tearDown
  514. $service->tearDownCall($sessionId);
  515. ]]></programlisting>
  516. </example>
  517. </sect2>
  518. <sect2 id="zend.service.developergarden.conferencecall">
  519. <title>ConferenceCall</title>
  520. <para>
  521. Konferenzanruf erlaubt es eine Telefonkonferenz zu konfigurieren und zu starten.
  522. </para>
  523. <para>
  524. Die folgenden Features sind vorhanden:
  525. </para>
  526. <itemizedlist>
  527. <listitem>
  528. <para>
  529. Konferenzen mit einem sofortigen Start
  530. </para>
  531. </listitem>
  532. <listitem>
  533. <para>
  534. Konferenzen mit einem definierten Startdatum
  535. </para>
  536. </listitem>
  537. <listitem>
  538. <para>
  539. Wiederkehrende Konferenzserien
  540. </para>
  541. </listitem>
  542. <listitem>
  543. <para>
  544. Teilnehmer einer Konferenz hinzufügen, löschen und lautlos stellen
  545. </para>
  546. </listitem>
  547. <listitem>
  548. <para>
  549. Templates für Konferenzen
  550. </para>
  551. </listitem>
  552. </itemizedlist>
  553. <para>
  554. Hier ist eine Liste der aktuell implementierten API Methoden:
  555. </para>
  556. <itemizedlist>
  557. <listitem>
  558. <para>
  559. <methodname>createConference()</methodname> erstellt eine neue Konferenz
  560. </para>
  561. </listitem>
  562. <listitem>
  563. <para>
  564. <methodname>updateConference()</methodname> aktualisiert eine existierende
  565. Konferenz
  566. </para>
  567. </listitem>
  568. <listitem>
  569. <para>
  570. <methodname>commitConference()</methodname> speichert die Konferenz, und wenn
  571. kein Datum konfiguriert wurde wird die Konferenz sofort gestartet
  572. </para>
  573. </listitem>
  574. <listitem>
  575. <para>
  576. <methodname>removeConference()</methodname> entfernt eine Konferenz
  577. </para>
  578. </listitem>
  579. <listitem>
  580. <para>
  581. <methodname>getConferenceList()</methodname> gibt eine Liste aller
  582. konfigurierten Konferenzen zurück
  583. </para>
  584. </listitem>
  585. <listitem>
  586. <para>
  587. <methodname>getConferenceStatus()</methodname> zeigt Informationen für eine
  588. existierende Konferenz an
  589. </para>
  590. </listitem>
  591. <listitem>
  592. <para>
  593. <methodname>getParticipantStatus()</methodname> zeigt Statusinformationen über
  594. einen Konferenzteilnehmer an
  595. </para>
  596. </listitem>
  597. <listitem>
  598. <para>
  599. <methodname>newParticipant()</methodname> erstellt einen neuen Teilnehmer
  600. </para>
  601. </listitem>
  602. <listitem>
  603. <para>
  604. <methodname>addParticipant()</methodname> fügt einen neuen Teilnehmer zu einer
  605. Konferenz hinzu
  606. </para>
  607. </listitem>
  608. <listitem>
  609. <para>
  610. <methodname>updateParticipant()</methodname> aktualisiert einen Teilnehmer,
  611. normalerweise um den Teilnehmer stumm zu schalten oder Ihn erneut anzurufen
  612. </para>
  613. </listitem>
  614. <listitem>
  615. <para>
  616. <methodname>removeParticipant()</methodname> entfernt einen Teilnehmer von einer
  617. Konferenz
  618. </para>
  619. </listitem>
  620. <listitem>
  621. <para>
  622. <methodname>getRunningConference()</methodname> fragt die laufende Instanz einer
  623. geplanten Konferenz ab
  624. </para>
  625. </listitem>
  626. <listitem>
  627. <para>
  628. <methodname>createConferenceTemplate()</methodname> erstellt ein neues
  629. Konferenztemplate
  630. </para>
  631. </listitem>
  632. <listitem>
  633. <para>
  634. <methodname>getConferenceTemplate()</methodname> fragt ein existierendes
  635. Konferenztemplate ab
  636. </para>
  637. </listitem>
  638. <listitem>
  639. <para>
  640. <methodname>updateConferenceTemplate()</methodname> aktualisiert die Details
  641. eines existierenden Konferenztemplates
  642. </para>
  643. </listitem>
  644. <listitem>
  645. <para>
  646. <methodname>removeConferenceTemplate()</methodname> entfernt ein
  647. Konferenztemplate
  648. </para>
  649. </listitem>
  650. <listitem>
  651. <para>
  652. <methodname>getConferenceTemplateList()</methodname> fragt alle
  653. Konferenztemplates eines Benutzers ab
  654. </para>
  655. </listitem>
  656. <listitem>
  657. <para>
  658. <methodname>addConferenceTemplateParticipant()</methodname> fügt einen
  659. Konferenzteilnehmer zu einem Konferenztemplate hinzu
  660. </para>
  661. </listitem>
  662. <listitem>
  663. <para>
  664. <methodname>getConferenceTemplateParticipant()</methodname> zeigt die Details
  665. des Teilnehmers eines Konferenztemplates an
  666. </para>
  667. </listitem>
  668. <listitem>
  669. <para>
  670. <methodname>updateConferenceTemplateParticipant()</methodname> aktualisiert die
  671. Details eines Teilnehmers in einem Konferenztemplate
  672. </para>
  673. </listitem>
  674. <listitem>
  675. <para>
  676. <methodname>removeConferenceTemplateParticipant()</methodname> entfernt einen
  677. Teilnehmer von einem Konferenztemplates
  678. </para>
  679. </listitem>
  680. </itemizedlist>
  681. <example id="zend.service.developergarden.conferencecall.example">
  682. <title>Ad-Hoc Konferenz</title>
  683. <programlisting language="php"><![CDATA[
  684. $client = new Zend_Service_DeveloperGarden_ConferenceCall($config);
  685. $conferenceDetails = new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail(
  686. 'Zend-Conference', // Name der Konferenz
  687. 'this is my private zend conference', // Beschreibung
  688. 60 // Dauer in Sekunden
  689. );
  690. $conference = $client->createConference('MeinName', $conferenceDetails);
  691. $part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail(
  692. 'Jon',
  693. 'Doe',
  694. '+49-123-4321',
  695. 'your.name@example.com',
  696. true
  697. );
  698. $client->newParticipant($conference->getConferenceId(), $part1);
  699. // add a second, third ... participant
  700. $client->commitConference($conference->getConferenceId());
  701. ]]></programlisting>
  702. </example>
  703. </sect2>
  704. <sect2 id="zend.service.developergarden.performance">
  705. <title>Geschwindigkeit und Cachen</title>
  706. <para>
  707. Man kann verschiedene Cacheoptionen setzen um die Geschwindigkeit zu verbessern um
  708. WSDL und Authentifizierungs Tokens aufzulösen.
  709. </para>
  710. <para>
  711. Als erstes müssen die Cachewerte des internen SoapClients (PHP) eingestellt werden.
  712. </para>
  713. <example id="zend.service.developergarden.performance.wsdlcache.example">
  714. <title>WSDL Cacheoptionen</title>
  715. <programlisting language="php"><![CDATA[
  716. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setWsdlCache([PHP KONSTANTE]);
  717. ]]></programlisting>
  718. </example>
  719. <para>
  720. Die <constant>[PHP KONSTANTE]</constant> kann eine der folgenden Werte enthalten:
  721. </para>
  722. <itemizedlist>
  723. <listitem>
  724. <para>
  725. <constant>WSDL_CACHE_DISC</constant>: aktiviert das Cachen auf Disk
  726. </para>
  727. </listitem>
  728. <listitem>
  729. <para>
  730. <constant>WSDL_CACHE_MEMORY</constant>: aktiviert das Cachen im Speicher
  731. </para>
  732. </listitem>
  733. <listitem>
  734. <para>
  735. <constant>WSDL_CACHE_BOTH</constant>: aktiviert das Cachen auf Disk und Speicher
  736. </para>
  737. </listitem>
  738. <listitem>
  739. <para>
  740. <constant>WSDL_CACHE_NONE</constant>: deaktiviert beide Caches
  741. </para>
  742. </listitem>
  743. </itemizedlist>
  744. <para>
  745. Wenn man das Ergebnis der Aufrufe zum SecuritTokenServer cachen will kann man eine
  746. Instanz von <classname>Zend_Cache</classname> einrichten und diese an
  747. <methodname>setCache()</methodname> übergeben.
  748. </para>
  749. <example id="zend.service.developergarden.performance.cache.example">
  750. <title>Cacheoptionen für SecurityTokenServer</title>
  751. <programlisting language="php"><![CDATA[
  752. $cache = Zend_Cache::factory('Core', ...);
  753. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);
  754. ]]></programlisting>
  755. </example>
  756. </sect2>
  757. </sect1>