documentation/manual/en/module_specs/Zend_Service_DeveloperGarden.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.service.developergarden">
   4     <title>Zend_Service_DeveloperGarden</title>
   5
   6     <sect2 id="zend.service.developergarden.introduction">
   7         <title>Introduction to DeveloperGarden</title>
   8
   9         <para>
  10             Developer Garden is the name of Deutsche Telekom’s developer community.
  11             Developer Garden offers you  access to core services of Deutsche Telekom,
  12             such as voice connections (Voice Call) or sending text messages (Send SMS)
  13             via open interfaces (Open APIs). You can access the Developer Garden
  14             services directly via <acronym>SOAP</acronym> or <acronym>REST</acronym>.
  15         </para>
  16
  17         <para>
  18             The family of <classname>Zend_Service_DeveloperGarden</classname> components provides a
  19             clean and simple interface to the <ulink
  20                 url="http://www.developergarden.com">Developer Garden APIs</ulink> and additionally
  21             offers functionality to improve handling and performance.
  22         </para>
  23
  24         <itemizedlist>
  25             <listitem>
  26                 <para>
  27                     <link
  28                         linkend="zend.service.developergarden.baseuserservice">BaseUserService</link>:
  29                     Class to manage API quota and user accounting details.
  30                 </para>
  31             </listitem>
  32
  33             <listitem>
  34                 <para>
  35                     <link linkend="zend.service.developergarden.iplocation">IPLocation</link>:
  36                     Locale the given IP and returns geo coordinates. Works only with IPs allocated
  37                     in the network of the Deutsche Telekom.
  38                     </para>
  39             </listitem>
  40
  41             <listitem>
  42                 <para>
  43                     <link linkend="zend.service.developergarden.localsearch">LocalSearch</link>:
  44                     Allows you to search with options nearby or around a given geo coordinate or
  45                     city.
  46                 </para>
  47             </listitem>
  48
  49             <listitem>
  50                 <para>
  51                     <link linkend="zend.service.developergarden.sendsms">SendSMS</link>: Send a SMS
  52                     or Flash SMS to a given number.
  53                 </para>
  54             </listitem>
  55
  56             <listitem>
  57                 <para>
  58                     <link linkend="zend.service.developergarden.smsvalidation">SMSValidation</link>:
  59                     You can validate a number to use it with SendSMS for also supply a back channel.
  60                 </para>
  61             </listitem>
  62
  63             <listitem>
  64                 <para>
  65                     <link linkend="zend.service.developergarden.voicecall">VoiceCall</link>:
  66                     Initiates a call between two participants.
  67                  </para>
  68             </listitem>
  69
  70             <listitem>
  71                 <para>
  72                     <link
  73                         linkend="zend.service.developergarden.conferencecall">ConferenceCall</link>:
  74                     You can configure a whole conference room with participants for an adhoc
  75                     conference or you can also schedule your conference.
  76                 </para>
  77             </listitem>
  78         </itemizedlist>
  79
  80         <para>
  81             The backend <acronym>SOAP</acronym> API is documented
  82             <ulink url="http://www.developergarden.com/openapi/dokumentation/">here</ulink>.
  83         </para>
  84
  85         <sect3 id="zend.service.developergarden.account">
  86             <title>Sign Up for an Account</title>
  87
  88             <para>
  89                 Before you can start using the DeveloperGarden API, you first have to
  90                 <ulink url="http://www.developergarden.com/register">sign up</ulink> for an account.
  91             </para>
  92         </sect3>
  93
  94         <sect3 id="zend.service.developergarden.environment">
  95             <title>The Environment</title>
  96
  97             <para>
  98                 With the DeveloperGarden API you have the possibility to choose between 3 different
  99                 development environments.
 100             </para>
 101
 102             <itemizedlist>
 103                 <listitem>
 104                     <para>
 105                         <emphasis>production</emphasis>: In Production environment there are no
 106                         usage limitations. You have to pay for calls, sms and other services with
 107                         costs.
 108                     </para>
 109                 </listitem>
 110
 111                 <listitem>
 112                     <para>
 113                         <emphasis>sandbox</emphasis>: In the Sandbox mode you can use the same
 114                         features (with limitations) as in the production without to paying
 115                         for them. This environment is suitable for testing your prototype.
 116                     </para>
 117                 </listitem>
 118
 119                 <listitem>
 120                     <para>
 121                         <emphasis>mock</emphasis>: The Mock environment allows you to build your
 122                         application and have results but you do not initiate any action on the API
 123                         side. This environment is intended for testing during development.
 124                     </para>
 125                 </listitem>
 126             </itemizedlist>
 127
 128             <para>
 129                 For every environment and service, there are some special features (options)
 130                 available for testing. Please look <ulink
 131                     url="http://www.developergarden.com/openapi/dokumentation/">here</ulink> for
 132                 details.
 133             </para>
 134         </sect3>
 135
 136         <sect3 id="zend.service.developergarden.config">
 137             <title>Your configuration</title>
 138
 139             <para>
 140                 You can pass to all classes an array of configuration values. Possible values are:
 141             </para>
 142
 143             <itemizedlist>
 144                 <listitem>
 145                     <para>
 146                         <emphasis>username</emphasis>: Your DeveloperGarden API username.
 147                     </para>
 148                 </listitem>
 149
 150                 <listitem>
 151                     <para>
 152                         <emphasis>password</emphasis>: Your DeveloperGarden API password.
 153                     </para>
 154                 </listitem>
 155
 156                 <listitem>
 157                     <para>
 158                         <emphasis>environment</emphasis>: The environment that you selected.
 159                     </para>
 160                 </listitem>
 161             </itemizedlist>
 162
 163             <example id="zend.service.developergarden.config.example">
 164                 <title>Configuration Example</title>
 165
 166                 <programlisting language="php"><![CDATA[
 167 require_once 'Zend/Service/DeveloperGarden/SendSms.php';
 168 $config = array(
 169     'username'    => 'yourUsername',
 170     'password'    => 'yourPassword',
 171     'environment' => Zend_Service_DeveloperGarden_SendSms::ENV_PRODUCTION,
 172 );
 173 $service = new Zend_Service_DeveloperGarden_SendSms($config);
 174 ]]></programlisting>
 175             </example>
 176         </sect3>
 177     </sect2>
 178
 179     <sect2 id="zend.service.developergarden.baseuserservice">
 180         <title>BaseUserService</title>
 181
 182         <para>
 183             The class can be used to set and get quota values for the services and to fetch
 184             account details.
 185         </para>
 186
 187         <para>
 188             The <methodname>getAccountBalance()</methodname> method fetches an array
 189             of account id's with the current balance status (credits).
 190         </para>
 191
 192         <example id="zend.service.developergarden.baseuserservice.getaccountbalance.example">
 193             <title>Get account balance example</title>
 194
 195             <programlisting language="php"><![CDATA[
 196 $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
 197 print_r($service->getAccountBalance());
 198 ]]></programlisting>
 199         </example>
 200
 201         <sect3 id="zend.service.developergarden.baseuserservice.getquotainformation">
 202             <title>Get quota information</title>
 203
 204             <para>
 205                 You can fetch quota informations for a specific service module with the
 206                 provided methods.
 207             </para>
 208
 209             <example id="zend.service.developergarden.baseuserservice.getquotainformation.example">
 210                 <title>Get quota information example</title>
 211
 212                 <programlisting language="php"><![CDATA[
 213 $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
 214 $result = $service->getSmsQuotaInformation(
 215     Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
 216 );
 217 echo 'Sms Quota:<br />';
 218 echo 'Max Quota: ', $result->getMaxQuota(), '<br />';
 219 echo 'Max User Quota: ', $result->getMaxUserQuota(), '<br />';
 220 echo 'Quota Level: ', $result->getQuotaLevel(), '<br />';
 221 ]]></programlisting>
 222             </example>
 223
 224             <para>
 225                 You get a <classname>result</classname> object that contains all the information
 226                 you need, optional you can pass to the <methodname>QuotaInformation</methodname>
 227                 method the environment constant to fetch the quota for the specific environment.
 228             </para>
 229
 230             <para>
 231                 Here a list of all <methodname>getQuotaInformation</methodname> methods:
 232             </para>
 233
 234             <itemizedlist>
 235                 <listitem>
 236                     <para>
 237                         <methodname>getConfernceCallQuotaInformation()</methodname>
 238                     </para>
 239                 </listitem>
 240
 241                 <listitem>
 242                     <para>
 243                         <methodname>getIPLocationQuotaInformation()</methodname>
 244                     </para>
 245                 </listitem>
 246
 247                 <listitem>
 248                     <para>
 249                         <methodname>getLocalSearchQuotaInformation()</methodname>
 250                     </para>
 251                 </listitem>
 252
 253                 <listitem>
 254                     <para>
 255                         <methodname>getSmsQuotaInformation()</methodname>
 256                     </para>
 257                 </listitem>
 258
 259                 <listitem>
 260                     <para>
 261                         <methodname>getVoiceCallQuotaInformation()</methodname>
 262                     </para>
 263                 </listitem>
 264             </itemizedlist>
 265         </sect3>
 266
 267         <sect3 id="zend.service.developergarden.baseuserservice.changequotainformation">
 268             <title>Change quota information</title>
 269
 270             <para>
 271                 To change the current quota use one of the <methodname>changeQuotaPool</methodname>
 272                 methods. First parameter is the new pool value and the second one is the
 273                 environment.
 274             </para>
 275
 276             <example
 277                 id="zend.service.developergarden.baseuserservice.changequotainformation.example">
 278                 <title>Change quota information example</title>
 279
 280                 <programlisting language="php"><![CDATA[
 281 $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
 282 $result = $service->changeSmsQuotaPool(
 283     1000,
 284     Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
 285 );
 286 if (!$result->hasError()) {
 287     echo 'updated Quota Pool';
 288 }
 289 ]]></programlisting>
 290             </example>
 291
 292             <para>
 293                 Here a list of all <methodname>changeQuotaPool</methodname> methods:
 294             </para>
 295
 296             <itemizedlist>
 297                 <listitem>
 298                     <para>
 299                         <methodname>changeConferenceCallQuotaPool()</methodname>
 300                     </para>
 301                 </listitem>
 302
 303                 <listitem>
 304                     <para>
 305                         <methodname>changeIPLocationQuotaPool()</methodname>
 306                     </para>
 307                 </listitem>
 308
 309                 <listitem>
 310                     <para>
 311                         <methodname>changeLocalSearchQuotaPool()</methodname>
 312                     </para>
 313                 </listitem>
 314
 315                 <listitem>
 316                     <para>
 317                         <methodname>changeSmsQuotaPool()</methodname>
 318                     </para>
 319                 </listitem>
 320
 321                 <listitem>
 322                     <para>
 323                         <methodname>changeVoiceCallQuotaPool()</methodname>
 324                     </para>
 325                 </listitem>
 326             </itemizedlist>
 327         </sect3>
 328     </sect2>
 329
 330     <sect2 id="zend.service.developergarden.iplocation">
 331         <title>IP Location</title>
 332
 333         <para>
 334             This service allows you to retrieve location information for a given IP address.
 335         </para>
 336
 337         <para>
 338             There are some limitations:
 339         </para>
 340
 341         <itemizedlist>
 342             <listitem>
 343                 <para>The IP address must be in the T-Home network</para>
 344             </listitem>
 345
 346             <listitem>
 347                 <para>Just the next big city will be resolved</para>
 348             </listitem>
 349
 350             <listitem>
 351                 <para>IPv6 is not supported yet</para>
 352             </listitem>
 353         </itemizedlist>
 354
 355         <example id="zend.service.developergarden.iplocation.locateip.example">
 356             <title>Locate a given IP</title>
 357
 358             <programlisting language="php"><![CDATA[
 359 $service = new Zend_Service_DeveloperGarden_IpLocation($config);
 360 $service->setEnvironment(
 361     Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
 362 );
 363 $ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
 364 print_r($service->locateIp($ip));
 365 ]]></programlisting>
 366         </example>
 367     </sect2>
 368
 369     <sect2 id="zend.service.developergarden.localsearch">
 370         <title>Local Search</title>
 371
 372         <para>
 373             The Local Search service provides the location based search machine <ulink
 374                 url="http://www.suchen.de">suchen.de</ulink> via web service interface. For
 375             more details, refer to <ulink
 376                 url="http://www.developergarden.com/static/docu/en/ch04s02s06.html">the
 377                 documentation</ulink>.
 378         </para>
 379
 380         <example id="zend.service.developergarden.localsearch.example">
 381             <title>Locate a Restaurant</title>
 382
 383             <programlisting language="php"><![CDATA[
 384 $service = new Zend_Service_DeveloperGarden_LocalSearch($config);
 385 $search  = new Zend_Service_DeveloperGarden_LocalSearch_SearchParameters();
 386 /**
 387  * @see http://www.developergarden.com/static/docu/en/ch04s02s06s04.html
 388  */
 389 $search->setWhat('pizza')
 390        ->setWhere('jena');
 391 print_r($service->localSearch($search));
 392 ]]></programlisting>
 393         </example>
 394     </sect2>
 395
 396     <sect2 id="zend.service.developergarden.sendsms">
 397         <title>Send SMS</title>
 398
 399         <para>
 400             The Send SMS service is used to send normal and Flash SMS to any number.
 401         </para>
 402
 403         <para>
 404             The following restrictions apply to the use of the SMS service:
 405         </para>
 406
 407         <itemizedlist>
 408             <listitem>
 409                 <para>
 410                     An SMS or Flash SMS in the production environment must not be longer than
 411                     765 characters and must not be sent to more than 10 recipients.
 412                 </para>
 413             </listitem>
 414
 415             <listitem>
 416                 <para>
 417                     An SMS or Flash SMS in the sandbox environment is shortened and enhanced by a
 418                     note from the DeveloperGarden. The maximum length of the message is 160
 419                     characters.
 420                 </para>
 421             </listitem>
 422
 423             <listitem>
 424                 <para>
 425                     In the sandbox environment, a maximum of 10 SMS can be sent per day.
 426                 </para>
 427             </listitem>
 428
 429             <listitem>
 430                 <para>
 431                     The following characters are counted twice:
 432                     <literal>| ^ € { } [ ] ~ \ LF</literal> (line break)
 433                 </para>
 434             </listitem>
 435
 436             <listitem>
 437                 <para>
 438                     If a SMS or Flash SMS is longer than 160 characters, one message is charged for
 439                     each 153 characters (quota and credit).
 440                 </para>
 441             </listitem>
 442
 443             <listitem>
 444                 <para>
 445                     Delivery cannot be guaranteed for SMS or Flash SMS to landline numbers.
 446                 </para>
 447             </listitem>
 448
 449             <listitem>
 450                 <para>
 451                     The sender can be a maximum of 11 characters. Permitted characters are
 452                     letters and numbers.
 453                 </para>
 454             </listitem>
 455
 456             <listitem>
 457                 <para>
 458                     The specification of a phone number as the sender is only permitted if the phone
 459                     number has been validated. (See: <link
 460                         linkend="zend.service.developergarden.smsvalidation">SMS Validation</link>)
 461                 </para>
 462             </listitem>
 463         </itemizedlist>
 464
 465         <example id="zend.service.developergarden.sendsms.example">
 466             <title>Sending an SMS</title>
 467
 468             <programlisting language="php"><![CDATA[
 469 $service = new Zend_Service_DeveloperGarden_SendSms($config);
 470 $sms = $service->createSms(
 471     '+49-172-123456; +49-177-789012',
 472     'your test message',
 473     'yourname'
 474 );
 475 print_r($service->send($sms));]]></programlisting>
 476         </example>
 477     </sect2>
 478
 479     <sect2 id="zend.service.developergarden.smsvalidation">
 480         <title>SMS Validation</title>
 481
 482         <para>
 483             The SMS Validation service allows the validation of physical phone number to be used
 484             as the sender of an SMS.
 485         </para>
 486
 487         <para>
 488             First, call <methodname>setValidationKeyword()</methodname> to receive an SMS
 489             with a keyword.
 490         </para>
 491
 492         <para>
 493             After you get your keyword, you have to use the <methodname>validate()</methodname> to
 494             validate your number with the keyword against the service.
 495         </para>
 496
 497         <para>
 498             With the method <methodname>getValidatedNumbers()</methodname>, you will get a list
 499             of all already validated numbers and the status of each.
 500         </para>
 501
 502         <example id="zend.service.developergarden.smsvalidation.request.example">
 503             <title>Request validation keyword</title>
 504
 505             <programlisting language="php"><![CDATA[
 506 $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
 507 print_r($service->sendValidationKeyword('+49-172-123456'));
 508 ]]></programlisting>
 509         </example>
 510
 511         <example id="zend.service.developergarden.smsvalidation.validate.example">
 512             <title>Validate a number with a keyword</title>
 513
 514             <programlisting language="php"><![CDATA[
 515 $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
 516 print_r($service->validate('TheKeyWord', '+49-172-123456'));
 517 ]]></programlisting>
 518         </example>
 519
 520         <para>
 521             To invalidate a validated number, call the method <methodname>inValidate()</methodname>.
 522         </para>
 523     </sect2>
 524
 525     <sect2 id="zend.service.developergarden.voicecall">
 526         <title>Voice Call</title>
 527
 528         <para>
 529             The Voice Call service can be used to set up a voice connection between two telephone
 530             connections. For specific details please read the <ulink
 531                 url="http://www.developergarden.com/static/docu/en/ch04s02.html">API
 532                 Documentation</ulink>.
 533         </para>
 534
 535         <para>
 536             Normally the Service works as followed:
 537         </para>
 538
 539         <itemizedlist>
 540             <listitem>
 541                 <para>
 542                     Call the first participant.
 543                 </para>
 544             </listitem>
 545
 546             <listitem>
 547                 <para>
 548                     If the connection is successful, call the second participant.
 549                 </para>
 550             </listitem>
 551
 552             <listitem>
 553                 <para>
 554                     If second participant connects succesfully, both participants are connected.
 555                 </para>
 556             </listitem>
 557
 558             <listitem>
 559                 <para>
 560                     The call is open until one of the participants hangs up or the expire mechanism
 561                     intercepts.
 562                 </para>
 563             </listitem>
 564         </itemizedlist>
 565
 566         <example id="zend.service.developergarden.voicecall.call.example">
 567             <title>Call two numbers</title>
 568
 569             <programlisting language="php"><![CDATA[
 570 $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
 571 $aNumber = '+49-30-000001';
 572 $bNumber = '+49-30-000002';
 573 $expiration  = 30;  // seconds
 574 $maxDuration = 300; // 5 mins
 575 $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
 576 echo $newCall->getSessionId();
 577 ]]></programlisting>
 578         </example>
 579
 580         <para>
 581             If the call is initiated, you can ask the result object for the session ID and
 582             use this session ID for an additional call to the <methodname>callStatus</methodname>
 583             or <methodname>tearDownCall()</methodname> methods. The second parameter on the
 584             <methodname>callStatus()</methodname> method call extends the expiration for this call.
 585         </para>
 586
 587         <example id="zend.service.developergarden.voicecall.teardown.example">
 588             <title>Call two numbers, ask for status, and cancel</title>
 589
 590             <programlisting language="php"><![CDATA[
 591 $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
 592 $aNumber = '+49-30-000001';
 593 $bNumber = '+49-30-000002';
 594 $expiration  = 30; // seconds
 595 $maxDuration = 300; // 5 mins
 596
 597 $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
 598
 599 $sessionId = $newCall->getSessionId();
 600
 601 $service->callStatus($sessionId, true); // extend the call
 602
 603 sleep(10); // sleep 10s and then tearDown
 604
 605 $service->tearDownCall($sessionId);
 606 ]]></programlisting>
 607         </example>
 608     </sect2>
 609
 610     <sect2 id="zend.service.developergarden.conferencecall">
 611         <title>ConferenceCall</title>
 612
 613         <para>
 614             Conference Call allows you to setup and start a phone conference.
 615         </para>
 616
 617         <para>
 618             The following features are available:
 619         </para>
 620
 621         <itemizedlist>
 622             <listitem>
 623                 <para>
 624                     Conferences with an immediate start
 625                 </para>
 626             </listitem>
 627
 628             <listitem>
 629                 <para>
 630                     Conferences with a defined start date
 631                 </para>
 632             </listitem>
 633
 634             <listitem>
 635                 <para>
 636                     Recurring conference series
 637                 </para>
 638             </listitem>
 639
 640             <listitem>
 641                 <para>
 642                     Adding, removing, and muting of participants from a conference
 643                 </para>
 644             </listitem>
 645
 646             <listitem>
 647                 <para>
 648                     Templates for conferences
 649                 </para>
 650             </listitem>
 651         </itemizedlist>
 652
 653         <para>
 654             Here is a list of currently implemented API methods:
 655         </para>
 656
 657         <itemizedlist>
 658             <listitem>
 659                 <para>
 660                     <methodname>createConference()</methodname> creates a new conference
 661                 </para>
 662             </listitem>
 663
 664             <listitem>
 665                 <para>
 666                     <methodname>updateConference()</methodname> updates an existing conference
 667                 </para>
 668             </listitem>
 669
 670             <listitem>
 671                 <para>
 672                     <methodname>commitConference()</methodname> saves the conference, and, if no
 673                     date is configured, immediately starts the conference
 674                 </para>
 675             </listitem>
 676
 677             <listitem>
 678                 <para>
 679                     <methodname>removeConference()</methodname> removes a conference
 680                 </para>
 681             </listitem>
 682
 683             <listitem>
 684                 <para>
 685                     <methodname>getConferenceList()</methodname> returns a list of all configured
 686                     conferences
 687                 </para>
 688             </listitem>
 689
 690             <listitem>
 691                 <para>
 692                     <methodname>getConferenceStatus()</methodname> displays information for an
 693                     existing conference
 694                 </para>
 695             </listitem>
 696
 697             <listitem>
 698                 <para>
 699                     <methodname>getParticipantStatus()</methodname> displays status information
 700                     about a conference participant
 701                 </para>
 702             </listitem>
 703
 704             <listitem>
 705                 <para>
 706                     <methodname>newParticipant()</methodname> creates a new participant
 707                 </para>
 708             </listitem>
 709
 710             <listitem>
 711                 <para>
 712                     <methodname>addParticipant()</methodname> adds a participant to a conference
 713                 </para>
 714             </listitem>
 715
 716             <listitem>
 717                 <para>
 718                     <methodname>updateParticipant()</methodname> updates a participant,
 719                     usually to mute or redial the participant
 720                 </para>
 721             </listitem>
 722
 723             <listitem>
 724                 <para>
 725                     <methodname>removeParticipant()</methodname> removes a participant from a
 726                     conference
 727                 </para>
 728             </listitem>
 729
 730             <listitem>
 731                 <para>
 732                     <methodname>getRunningConference()</methodname> requests the running instance of
 733                     a planned conference
 734                 </para>
 735             </listitem>
 736
 737             <listitem>
 738                 <para>
 739                     <methodname>createConferenceTemplate()</methodname> creates a new conference
 740                     template
 741                 </para>
 742             </listitem>
 743
 744             <listitem>
 745                 <para>
 746                     <methodname>getConferenceTemplate()</methodname> requests an existing conference
 747                     template
 748                 </para>
 749             </listitem>
 750
 751             <listitem>
 752                 <para>
 753                     <methodname>updateConferenceTemplate()</methodname> updates existing conference
 754                     template details
 755                 </para>
 756             </listitem>
 757
 758             <listitem>
 759                 <para>
 760                     <methodname>removeConferenceTemplate()</methodname> removes a conference
 761                     template
 762                 </para>
 763             </listitem>
 764
 765             <listitem>
 766                 <para>
 767                     <methodname>getConferenceTemplateList()</methodname> requests all conference
 768                     templates of an owner
 769                 </para>
 770             </listitem>
 771
 772             <listitem>
 773                 <para>
 774                     <methodname>addConferenceTemplateParticipant()</methodname> adds a conference
 775                     participant to conference template
 776                 </para>
 777             </listitem>
 778
 779             <listitem>
 780                 <para>
 781                     <methodname>getConferenceTemplateParticipant()</methodname> displays details of
 782                     a participant of a conference template
 783                 </para>
 784             </listitem>
 785
 786             <listitem>
 787                 <para>
 788                     <methodname>updateConferenceTemplateParticipant()</methodname> updates
 789                     participant details within a conference template
 790                 </para>
 791             </listitem>
 792
 793             <listitem>
 794                 <para>
 795                     <methodname>removeConferenceTemplateParticipant()</methodname> removes
 796                     a participant from a conference template
 797                 </para>
 798             </listitem>
 799         </itemizedlist>
 800
 801         <example id="zend.service.developergarden.conferencecall.example">
 802             <title>Ad-Hoc conference</title>
 803
 804             <programlisting language="php"><![CDATA[
 805 $client = new Zend_Service_DeveloperGarden_ConferenceCall($config);
 806
 807 $conferenceDetails = new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail(
 808     'Zend-Conference',                    // name for the conference
 809     'this is my private zend conference', // description
 810     60                                    // duration in seconds
 811 );
 812
 813 $conference = $client->createConference('MyName', $conferenceDetails);
 814
 815 $part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail(
 816     'Jon',
 817     'Doe',
 818     '+49-123-4321',
 819     'your.name@example.com',
 820     true
 821 );
 822
 823 $client->newParticipant($conference->getConferenceId(), $part1);
 824 // add a second, third ... participant
 825
 826 $client->commitConference($conference->getConferenceId());
 827 ]]></programlisting>
 828         </example>
 829     </sect2>
 830
 831     <sect2 id="zend.service.developergarden.performance">
 832         <title>Performance and Caching</title>
 833
 834         <para>
 835             You can setup various caching options to improve the performance for resolving WSDL and
 836             authentication tokens.
 837         </para>
 838
 839         <para>
 840             First of all, you can setup the internal SoapClient (PHP) caching values.
 841         </para>
 842
 843         <example id="zend.service.developergarden.performance.wsdlcache.example">
 844             <title>WSDL cache options</title>
 845
 846             <programlisting language="php"><![CDATA[
 847 Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setWsdlCache([PHP CONSTANT]);
 848 ]]></programlisting>
 849         </example>
 850
 851         <para>
 852             The <constant>[PHP CONSTANT]</constant> can be one of the following values:
 853         </para>
 854
 855         <itemizedlist>
 856             <listitem>
 857                 <para>
 858                     <constant>WSDL_CACHE_DISC</constant>: enabled disc caching
 859                 </para>
 860             </listitem>
 861
 862             <listitem>
 863                 <para>
 864                     <constant>WSDL_CACHE_MEMORY</constant>: enabled memory caching
 865                 </para>
 866             </listitem>
 867
 868             <listitem>
 869                 <para>
 870                     <constant>WSDL_CACHE_BOTH</constant>: enabled disc and memory caching
 871                 </para>
 872             </listitem>
 873
 874             <listitem>
 875                 <para>
 876                     <constant>WSDL_CACHE_NONE</constant>: disabled both caching
 877                 </para>
 878             </listitem>
 879         </itemizedlist>
 880
 881         <para>
 882             If you also want to cache the result for calls to the SecuritTokenServer
 883             you can setup a <classname>Zend_Cache</classname> instance and pass it to the
 884             <methodname>setCache()</methodname>.
 885         </para>
 886
 887         <example id="zend.service.developergarden.performance.cache.example">
 888             <title>SecurityTokenServer cache option</title>
 889
 890             <programlisting language="php"><![CDATA[
 891 $cache = Zend_Cache::factory('Core', ...);
 892 Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);
 893 ]]></programlisting>
 894         </example>
 895     </sect2>
 896 </sect1>