2
0

Zend_Service_DeveloperGarden.xml 31 KB

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