Zend_Service_DeveloperGarden.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20760 -->
  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 Bezahlservices 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>
  207. <methodname>getConfernceCallQuotaInformation()</methodname>
  208. </para>
  209. </listitem>
  210. <listitem>
  211. <para>
  212. <methodname>getIPLocationQuotaInformation()</methodname>
  213. </para>
  214. </listitem>
  215. <listitem>
  216. <para>
  217. <methodname>getLocalSearchQuotaInformation()</methodname>
  218. </para>
  219. </listitem>
  220. <listitem>
  221. <para>
  222. <methodname>getSmsQuotaInformation()</methodname>
  223. </para>
  224. </listitem>
  225. <listitem>
  226. <para>
  227. <methodname>getVoiceCallQuotaInformation()</methodname>
  228. </para>
  229. </listitem>
  230. </itemizedlist>
  231. </sect3>
  232. <sect3 id="zend.service.developergarden.baseuserservice.changequotainformation">
  233. <title>Quoteninformationen ändern</title>
  234. <para>
  235. Um die aktuelle Quote zu ändern kann eine der
  236. <methodname>changeQuotaPool</methodname> Methoden verwendet werden. Der erste
  237. Parameter ist der neue Poolwert und der zweite ist die Umgebung.
  238. </para>
  239. <example
  240. id="zend.service.developergarden.baseuserservice.changequotainformation.example">
  241. <title>Beispiel zum Ändern der Quoteninformation</title>
  242. <programlisting language="php"><![CDATA[
  243. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  244. $result = $service->changeSmsQuotaPool(
  245. 1000,
  246. Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
  247. );
  248. if (!$result->hasError()) {
  249. echo 'updated Quota Pool';
  250. }
  251. ]]></programlisting>
  252. </example>
  253. <para>
  254. Hier ist eine Liste aller <methodname>changeQuotaPool</methodname> Methoden:
  255. </para>
  256. <itemizedlist>
  257. <listitem>
  258. <para>
  259. <methodname>changeConferenceCallQuotaPool()</methodname>
  260. </para>
  261. </listitem>
  262. <listitem>
  263. <para>
  264. <methodname>changeIPLocationQuotaPool()</methodname>
  265. </para>
  266. </listitem>
  267. <listitem>
  268. <para>
  269. <methodname>changeLocalSearchQuotaPool()</methodname>
  270. </para>
  271. </listitem>
  272. <listitem>
  273. <para>
  274. <methodname>changeSmsQuotaPool()</methodname>
  275. </para>
  276. </listitem>
  277. <listitem>
  278. <para>
  279. <methodname>changeVoiceCallQuotaPool()</methodname>
  280. </para>
  281. </listitem>
  282. </itemizedlist>
  283. </sect3>
  284. </sect2>
  285. <sect2 id="zend.service.developergarden.iplocation">
  286. <title>IP Lokalisierung</title>
  287. <para>
  288. Dieser Service erlaubt es Lokalisierungsinformationen für eine gegebene IP Adresse zu
  289. erhalten.
  290. </para>
  291. <para>
  292. Es gibt einige Einschränkungen:
  293. </para>
  294. <itemizedlist>
  295. <listitem>
  296. <para>Die IP Adresse muss im T-Home Netzwerk sein</para>
  297. </listitem>
  298. <listitem>
  299. <para>Nur die nächste größere Stadt wird aufgelöst</para>
  300. </listitem>
  301. <listitem>
  302. <para>IPv6 wird aktuell nicht unterstützt</para>
  303. </listitem>
  304. </itemizedlist>
  305. <example id="zend.service.developergarden.iplocation.locateip.example">
  306. <title>Eine gegebene IP lokalisieren</title>
  307. <programlisting language="php"><![CDATA[
  308. $service = new Zend_Service_DeveloperGarden_IpLocation($config);
  309. $service->setEnvironment(
  310. Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
  311. );
  312. $ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
  313. print_r($service->locateIp($ip));
  314. ]]></programlisting>
  315. </example>
  316. </sect2>
  317. <sect2 id="zend.service.developergarden.localsearch">
  318. <title>Lokalsuche</title>
  319. <para>
  320. Der Lokalsuch Service bietet die lokale Suchmaschine <ulink
  321. url="http://www.suchen.de">suchen.de</ulink> über ein Webservice Interface an. Für
  322. weitere Details wird auf <ulink
  323. url="http://www.developergarden.com/static/docu/en/ch04s02s06.html">die
  324. Dokumentation</ulink> verwiesen.
  325. </para>
  326. <example id="zend.service.developergarden.localsearch.example">
  327. <title>Ein Restaurant lokalisieren</title>
  328. <programlisting language="php"><![CDATA[
  329. $service = new Zend_Service_DeveloperGarden_LocalSearch($config);
  330. $search = new Zend_Service_DeveloperGarden_LocalSearch_SearchParameters();
  331. /**
  332. * @see http://www.developergarden.com/static/docu/en/ch04s02s06s04.html
  333. */
  334. $search->setWhat('pizza')
  335. ->setWhere('jena');
  336. print_r($service->localSearch($search));
  337. ]]></programlisting>
  338. </example>
  339. </sect2>
  340. <sect2 id="zend.service.developergarden.sendsms">
  341. <title>SMS senden</title>
  342. <para>
  343. Der SMS Versandservice wird verwendet um normale und Flash SMS zu beliebigen Nummern zu
  344. versenden.
  345. </para>
  346. <para>
  347. Die folgenden Einschränkungen sind auf die Verwendung des SMS Service anzuwenden:
  348. </para>
  349. <itemizedlist>
  350. <listitem>
  351. <para>
  352. Eine SMS oder Flash SMS darf in der Produktionsumgebung nicht länger als 765
  353. Zeichen sein und darf maximal an 10 Empfänger versendet werden.
  354. </para>
  355. </listitem>
  356. <listitem>
  357. <para>
  358. Eine SMS oder Flash SMS wird in der Sandboxumgebung gekürzt und mit einer Notiz
  359. in DeveloperGarden ausgestattet. Die maximale Länger der gesendeten Nachricht
  360. beträgt 160 Zeichen.
  361. </para>
  362. </listitem>
  363. <listitem>
  364. <para>
  365. In der Sandboxumgebug können maximal 10 SMS pro Tag versendet werden.
  366. </para>
  367. </listitem>
  368. <listitem>
  369. <para>
  370. Die folgenden Zeichen werden doppelt gezählt:
  371. <literal>| ^ € { } [ ] ~ \ LF</literal> (Zeilenumbruch)
  372. </para>
  373. </listitem>
  374. <listitem>
  375. <para>
  376. Wenn eine SMS oder Flash SMS länger als 160 Zeichen ist, wird immer für 153
  377. weitere Zeichen eine Nachricht berechnet (Quote und Kredit).
  378. </para>
  379. </listitem>
  380. <listitem>
  381. <para>
  382. Die Zustellung kann für SMS oder Flsh SMS bei Festnetzanschlüssen nicht
  383. garantiert werden.
  384. </para>
  385. </listitem>
  386. <listitem>
  387. <para>
  388. Der Sender darf maximal aus 11 Zeichen bestehen. Erlaubte Zeichen sind
  389. Buchstaben und Zahlen.
  390. </para>
  391. </listitem>
  392. <listitem>
  393. <para>
  394. Die Spezifikation einer Telefonnummer als Sender ist nur erlaubt wenn die
  395. Telefonnummer geprüft wurde. (Siehe <link
  396. linkend="zend.service.developergarden.smsvalidation">SMS Prüfung</link>)
  397. </para>
  398. </listitem>
  399. </itemizedlist>
  400. <example id="zend.service.developergarden.sendsms.example">
  401. <title>Senden einer SMS</title>
  402. <programlisting language="php"><![CDATA[
  403. $service = new Zend_Service_DeveloperGarden_SendSms($config);
  404. $sms = $service->createSms(
  405. '+49-172-123456; +49-177-789012',
  406. 'die Testnachricht',
  407. 'meinName'
  408. );
  409. print_r($service->send($sms));]]></programlisting>
  410. </example>
  411. </sect2>
  412. <sect2 id="zend.service.developergarden.smsvalidation">
  413. <title>SMS Prüfung</title>
  414. <para>
  415. Der SMS Prüfservice erlaubt die Prüfung einer physikalischen Telefonnummer um diese als
  416. Sender einer SMS zu verwenden.
  417. </para>
  418. <para>
  419. Zuerst muss <methodname>setValidationKeyword()</methodname> aufgerufen werden um eine
  420. SMS mit einem Schlüsselwort zu empfangen.
  421. </para>
  422. <para>
  423. Nachdem man sein Schlüsselwort erhalten hat, muss man
  424. <methodname>validate()</methodname> verwenden um die Nummer mit dem Schlüsselwort gegen
  425. das Service zu prüfen.
  426. </para>
  427. <para>
  428. Mit der Methode <methodname>getValidatedNumbers()</methodname> erhält man eine Liste
  429. aller bereits geprüften Nummern und den Status einer jeden.
  430. </para>
  431. <example id="zend.service.developergarden.smsvalidation.request.example">
  432. <title>Prüfschlüsselwörter anfragen</title>
  433. <programlisting language="php"><![CDATA[
  434. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  435. print_r($service->sendValidationKeyword('+49-172-123456'));
  436. ]]></programlisting>
  437. </example>
  438. <example id="zend.service.developergarden.smsvalidation.validate.example">
  439. <title>Eine Nummer mit einem Schlüsselwort prüfen</title>
  440. <programlisting language="php"><![CDATA[
  441. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  442. print_r($service->validate('DasSchlüsselWort', '+49-172-123456'));
  443. ]]></programlisting>
  444. </example>
  445. <para>
  446. Um eine geprüft Nummer als ungeprüft zu markieren muss die Methode
  447. <methodname>inValidate()</methodname> aufgerufen werden.
  448. </para>
  449. </sect2>
  450. <sect2 id="zend.service.developergarden.voicecall">
  451. <title>Sprachanruf</title>
  452. <para>
  453. Der Sprachanruf Service wird für das Setzen einer Sprachverbindung zwischen zwei
  454. Telefonverbindungen verwendet. Für spezifische Details lesen Sie bitte die <ulink
  455. url="http://www.developergarden.com/static/docu/en/ch04s02.html">API
  456. Dokumentation</ulink>.
  457. </para>
  458. <para>
  459. Normalerweise arbeitet der Service wie folgt:
  460. </para>
  461. <itemizedlist>
  462. <listitem>
  463. <para>
  464. Den ersten Teilnehmer anrufen.
  465. </para>
  466. </listitem>
  467. <listitem>
  468. <para>
  469. Wenn die Verbindung erfolgreich war, den zweiten Teilnehmer anrufen.
  470. </para>
  471. </listitem>
  472. <listitem>
  473. <para>
  474. Wenn der zweite Teilnehmer erfolgreich verbunden ist, werden beide Teilnehmer
  475. miteinander verbunden.
  476. </para>
  477. </listitem>
  478. <listitem>
  479. <para>
  480. Der Anruf bleibt geöffnet bis einer der Teilnehmer auflegt oder der
  481. Ablaufmechanismus eingreift.
  482. </para>
  483. </listitem>
  484. </itemizedlist>
  485. <example id="zend.service.developergarden.voicecall.call.example">
  486. <title>Zwei Nummern anrufen</title>
  487. <programlisting language="php"><![CDATA[
  488. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  489. $aNumber = '+49-30-000001';
  490. $bNumber = '+49-30-000002';
  491. $expiration = 30; // Sekunden
  492. $maxDuration = 300; // 5 Minuten
  493. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  494. echo $newCall->getSessionId();
  495. ]]></programlisting>
  496. </example>
  497. <para>
  498. Wenn der Anruf initiiert wurde, kann das Ergebnisobjekt nach der Session ID gefragt
  499. werden und diese Session ID für einen zusätzlichen Aufruf der Methoden
  500. <methodname>callStatus</methodname> oder <methodname>tearDownCall()</methodname>
  501. verwendet werden. Der zweite Parameter der Methode <methodname>callStatus()</methodname>
  502. erweitert die Ablaufzeit für diesen Anruf.
  503. </para>
  504. <example id="zend.service.developergarden.voicecall.teardown.example">
  505. <title>Zwei Nummern anrufen, den Status abfragen und Trennen</title>
  506. <programlisting language="php"><![CDATA[
  507. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  508. $aNumber = '+49-30-000001';
  509. $bNumber = '+49-30-000002';
  510. $expiration = 30; // Sekunden
  511. $maxDuration = 300; // 5 Minuten
  512. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  513. $sessionId = $newCall->getSessionId();
  514. $service->callStatus($sessionId, true); // Den Anruf verlängern
  515. sleep(10); // 10s schlummern und dann tearDown
  516. $service->tearDownCall($sessionId);
  517. ]]></programlisting>
  518. </example>
  519. </sect2>
  520. <sect2 id="zend.service.developergarden.conferencecall">
  521. <title>ConferenceCall</title>
  522. <para>
  523. Konferenzanruf erlaubt es eine Telefonkonferenz zu konfigurieren und zu starten.
  524. </para>
  525. <para>
  526. Die folgenden Features sind vorhanden:
  527. </para>
  528. <itemizedlist>
  529. <listitem>
  530. <para>
  531. Konferenzen mit einem sofortigen Start
  532. </para>
  533. </listitem>
  534. <listitem>
  535. <para>
  536. Konferenzen mit einem definierten Startdatum
  537. </para>
  538. </listitem>
  539. <listitem>
  540. <para>
  541. Wiederkehrende Konferenzserien
  542. </para>
  543. </listitem>
  544. <listitem>
  545. <para>
  546. Teilnehmer einer Konferenz hinzufügen, löschen und lautlos stellen
  547. </para>
  548. </listitem>
  549. <listitem>
  550. <para>
  551. Templates für Konferenzen
  552. </para>
  553. </listitem>
  554. </itemizedlist>
  555. <para>
  556. Hier ist eine Liste der aktuell implementierten API Methoden:
  557. </para>
  558. <itemizedlist>
  559. <listitem>
  560. <para>
  561. <methodname>createConference()</methodname> erstellt eine neue Konferenz
  562. </para>
  563. </listitem>
  564. <listitem>
  565. <para>
  566. <methodname>updateConference()</methodname> aktualisiert eine existierende
  567. Konferenz
  568. </para>
  569. </listitem>
  570. <listitem>
  571. <para>
  572. <methodname>commitConference()</methodname> speichert die Konferenz, und wenn
  573. kein Datum konfiguriert wurde wird die Konferenz sofort gestartet
  574. </para>
  575. </listitem>
  576. <listitem>
  577. <para>
  578. <methodname>removeConference()</methodname> entfernt eine Konferenz
  579. </para>
  580. </listitem>
  581. <listitem>
  582. <para>
  583. <methodname>getConferenceList()</methodname> gibt eine Liste aller
  584. konfigurierten Konferenzen zurück
  585. </para>
  586. </listitem>
  587. <listitem>
  588. <para>
  589. <methodname>getConferenceStatus()</methodname> zeigt Informationen für eine
  590. existierende Konferenz an
  591. </para>
  592. </listitem>
  593. <listitem>
  594. <para>
  595. <methodname>getParticipantStatus()</methodname> zeigt Statusinformationen über
  596. einen Konferenzteilnehmer an
  597. </para>
  598. </listitem>
  599. <listitem>
  600. <para>
  601. <methodname>newParticipant()</methodname> erstellt einen neuen Teilnehmer
  602. </para>
  603. </listitem>
  604. <listitem>
  605. <para>
  606. <methodname>addParticipant()</methodname> fügt einen neuen Teilnehmer zu einer
  607. Konferenz hinzu
  608. </para>
  609. </listitem>
  610. <listitem>
  611. <para>
  612. <methodname>updateParticipant()</methodname> aktualisiert einen Teilnehmer,
  613. normalerweise um den Teilnehmer stumm zu schalten oder Ihn erneut anzurufen
  614. </para>
  615. </listitem>
  616. <listitem>
  617. <para>
  618. <methodname>removeParticipant()</methodname> entfernt einen Teilnehmer von einer
  619. Konferenz
  620. </para>
  621. </listitem>
  622. <listitem>
  623. <para>
  624. <methodname>getRunningConference()</methodname> fragt die laufende Instanz einer
  625. geplanten Konferenz ab
  626. </para>
  627. </listitem>
  628. <listitem>
  629. <para>
  630. <methodname>createConferenceTemplate()</methodname> erstellt ein neues
  631. Konferenztemplate
  632. </para>
  633. </listitem>
  634. <listitem>
  635. <para>
  636. <methodname>getConferenceTemplate()</methodname> fragt ein existierendes
  637. Konferenztemplate ab
  638. </para>
  639. </listitem>
  640. <listitem>
  641. <para>
  642. <methodname>updateConferenceTemplate()</methodname> aktualisiert die Details
  643. eines existierenden Konferenztemplates
  644. </para>
  645. </listitem>
  646. <listitem>
  647. <para>
  648. <methodname>removeConferenceTemplate()</methodname> entfernt ein
  649. Konferenztemplate
  650. </para>
  651. </listitem>
  652. <listitem>
  653. <para>
  654. <methodname>getConferenceTemplateList()</methodname> fragt alle
  655. Konferenztemplates eines Benutzers ab
  656. </para>
  657. </listitem>
  658. <listitem>
  659. <para>
  660. <methodname>addConferenceTemplateParticipant()</methodname> fügt einen
  661. Konferenzteilnehmer zu einem Konferenztemplate hinzu
  662. </para>
  663. </listitem>
  664. <listitem>
  665. <para>
  666. <methodname>getConferenceTemplateParticipant()</methodname> zeigt die Details
  667. des Teilnehmers eines Konferenztemplates an
  668. </para>
  669. </listitem>
  670. <listitem>
  671. <para>
  672. <methodname>updateConferenceTemplateParticipant()</methodname> aktualisiert die
  673. Details eines Teilnehmers in einem Konferenztemplate
  674. </para>
  675. </listitem>
  676. <listitem>
  677. <para>
  678. <methodname>removeConferenceTemplateParticipant()</methodname> entfernt einen
  679. Teilnehmer von einem Konferenztemplates
  680. </para>
  681. </listitem>
  682. </itemizedlist>
  683. <example id="zend.service.developergarden.conferencecall.example">
  684. <title>Ad-Hoc Konferenz</title>
  685. <programlisting language="php"><![CDATA[
  686. $client = new Zend_Service_DeveloperGarden_ConferenceCall($config);
  687. $conferenceDetails = new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail(
  688. 'Zend-Conference', // Name der Konferenz
  689. 'this is my private zend conference', // Beschreibung
  690. 60 // Dauer in Sekunden
  691. );
  692. $conference = $client->createConference('MeinName', $conferenceDetails);
  693. $part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail(
  694. 'Jon',
  695. 'Doe',
  696. '+49-123-4321',
  697. 'your.name@example.com',
  698. true
  699. );
  700. $client->newParticipant($conference->getConferenceId(), $part1);
  701. // add a second, third ... participant
  702. $client->commitConference($conference->getConferenceId());
  703. ]]></programlisting>
  704. </example>
  705. </sect2>
  706. <sect2 id="zend.service.developergarden.performance">
  707. <title>Geschwindigkeit und Cachen</title>
  708. <para>
  709. Man kann verschiedene Cacheoptionen setzen um die Geschwindigkeit zu verbessern um
  710. WSDL und Authentifizierungs Tokens aufzulösen.
  711. </para>
  712. <para>
  713. Als erstes müssen die Cachewerte des internen SoapClients (PHP) eingestellt werden.
  714. </para>
  715. <example id="zend.service.developergarden.performance.wsdlcache.example">
  716. <title>WSDL Cacheoptionen</title>
  717. <programlisting language="php"><![CDATA[
  718. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setWsdlCache([PHP KONSTANTE]);
  719. ]]></programlisting>
  720. </example>
  721. <para>
  722. Die <constant>[PHP KONSTANTE]</constant> kann eine der folgenden Werte enthalten:
  723. </para>
  724. <itemizedlist>
  725. <listitem>
  726. <para>
  727. <constant>WSDL_CACHE_DISC</constant>: aktiviert das Cachen auf Disk
  728. </para>
  729. </listitem>
  730. <listitem>
  731. <para>
  732. <constant>WSDL_CACHE_MEMORY</constant>: aktiviert das Cachen im Speicher
  733. </para>
  734. </listitem>
  735. <listitem>
  736. <para>
  737. <constant>WSDL_CACHE_BOTH</constant>: aktiviert das Cachen auf Disk und Speicher
  738. </para>
  739. </listitem>
  740. <listitem>
  741. <para>
  742. <constant>WSDL_CACHE_NONE</constant>: deaktiviert beide Caches
  743. </para>
  744. </listitem>
  745. </itemizedlist>
  746. <para>
  747. Wenn man das Ergebnis der Aufrufe zum SecuritTokenServer cachen will kann man eine
  748. Instanz von <classname>Zend_Cache</classname> einrichten und diese an
  749. <methodname>setCache()</methodname> übergeben.
  750. </para>
  751. <example id="zend.service.developergarden.performance.cache.example">
  752. <title>Cacheoptionen für SecurityTokenServer</title>
  753. <programlisting language="php"><![CDATA[
  754. $cache = Zend_Cache::factory('Core', ...);
  755. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);
  756. ]]></programlisting>
  757. </example>
  758. </sect2>
  759. </sect1>