Zend_Service_DeveloperGarden.xml 31 KB

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