Bandwidth PHP SDK
  • Namespace
  • Class

Namespaces

  • Catapult
  • None

Classes

  • Catapult\Account
  • Catapult\AnswerCallEvent
  • Catapult\Application
  • Catapult\ApplicationCollection
  • Catapult\AudioMixin
  • Catapult\BaML
  • Catapult\BaMLAssert
  • Catapult\BaMLAttribute
  • Catapult\BaMLContainer
  • Catapult\BaMLGather
  • Catapult\BaMLGeneric
  • Catapult\BaMLHangup
  • Catapult\BaMLPlayAudio
  • Catapult\BaMLRedirect
  • Catapult\BaMLResource
  • Catapult\BaMLSendMessage
  • Catapult\BaMLSpeakSentence
  • Catapult\BaMLText
  • Catapult\BaMLTransfer
  • Catapult\BaMLVerb
  • Catapult\BaMLVerbGather
  • Catapult\BaMLVerbHangup
  • Catapult\BaMLVerbPlayAudio
  • Catapult\BaMLVerbRecord
  • Catapult\BaMLVerbRedirect
  • Catapult\BaMLVerbSendMessage
  • Catapult\BaMLVerbSpeakSentence
  • Catapult\BaMLVerbTransfer
  • Catapult\BaseResource
  • Catapult\BaseUtilities
  • Catapult\Bridge
  • Catapult\BridgeCollection
  • Catapult\Call
  • Catapult\Callback
  • Catapult\CallCollection
  • Catapult\CallCombo
  • Catapult\CallEvent
  • Catapult\CallEvents
  • Catapult\CallEventsCollection
  • Catapult\Cleaner
  • Catapult\Client
  • Catapult\ClientResource
  • Catapult\CollectionIterator
  • Catapult\CollectionObject
  • Catapult\CollectionSequence
  • Catapult\Conference
  • Catapult\ConferenceEventMixin
  • Catapult\ConferenceMember
  • Catapult\ConferenceMemberEvent
  • Catapult\ConferencePlaybackEvent
  • Catapult\Constructor
  • Catapult\Converter
  • Catapult\Credentials
  • Catapult\CredentialsUser
  • Catapult\DataPacket
  • Catapult\DataPacketCollection
  • Catapult\Date
  • Catapult\DependsObject
  • Catapult\DependsResource
  • Catapult\Domains
  • Catapult\DomainsCollection
  • Catapult\DTMF
  • Catapult\DtmfCallEvent
  • Catapult\Endpoints
  • Catapult\EndpointsCollection
  • Catapult\EndpointsCredentials
  • Catapult\EndpointsMulti
  • Catapult\EndpointsToken
  • Catapult\Ensure
  • Catapult\EnsureResource
  • Catapult\ErrorCallEvent
  • Catapult\Event
  • Catapult\EventAssert
  • Catapult\EventCollection
  • Catapult\EventResource
  • Catapult\EventType
  • Catapult\FileHandler
  • Catapult\Gather
  • Catapult\GatherCallEvent
  • Catapult\GatherCollection
  • Catapult\GenericResource
  • Catapult\HangupCallEvent
  • Catapult\Id
  • Catapult\IncomingCallEvent
  • Catapult\LoadsResource
  • Catapult\Locator
  • Catapult\Log
  • Catapult\Media
  • Catapult\MediaCollection
  • Catapult\MediaURL
  • Catapult\Message
  • Catapult\MessageCollection
  • Catapult\MessageEvent
  • Catapult\MessageMulti
  • Catapult\MetaResource
  • Catapult\Multi
  • Catapult\NumberInfo
  • Catapult\Page
  • Catapult\Parameters
  • Catapult\PathResource
  • Catapult\PhoneCombo
  • Catapult\PhoneNumber
  • Catapult\PhoneNumbers
  • Catapult\PhoneNumbersCollection
  • Catapult\PlaybackCallEvent
  • Catapult\PrototypeUtility
  • Catapult\Recording
  • Catapult\RecordingCallEvent
  • Catapult\RecordingCollection
  • Catapult\RejectCallEvent
  • Catapult\RemoveResource
  • Catapult\Resolver
  • Catapult\ResolverResource
  • Catapult\RESTClient
  • Catapult\SchemaResource
  • Catapult\Sentence
  • Catapult\SIP
  • Catapult\SIPRealm
  • Catapult\Size
  • Catapult\SpeakCallEvent
  • Catapult\StringifyResource
  • Catapult\SubfunctionObject
  • Catapult\SubFunctionResource
  • Catapult\TextMessage
  • Catapult\Timeout
  • Catapult\TimeoutCallEvent
  • Catapult\TitleUtility
  • Catapult\Transaction
  • Catapult\TransactionCollection
  • Catapult\Transcription
  • Catapult\TranscriptionCallEvent
  • Catapult\TranscriptionCollection
  • Catapult\Types
  • Catapult\URIResource
  • Catapult\UserError
  • Catapult\UserErrorCollection
  • Catapult\VerifyResource
  • Catapult\Voice
  • Catapult\XMLUtility
  • CatapultApiWarning

Interfaces

  • Catapult\API
  • Catapult\API_MODE
  • Catapult\BAML_SETTINGS
  • Catapult\BAML_VERBS
  • Catapult\BAML_XML_HANDLERS
  • Catapult\BAML_XML_METHODS
  • Catapult\BAML_XML_OPTIONS
  • Catapult\CALL_ERROR
  • Catapult\CALL_STATES
  • Catapult\CONFERENCE_MEMBER_STATES
  • Catapult\CONFERENCE_SPEAK_STATES
  • Catapult\CONFERENCE_STATES
  • Catapult\DEFAULTS
  • Catapult\EXCEPTIONS
  • Catapult\GATHER_REASONS
  • Catapult\GATHER_STATES
  • Catapult\MESSAGE_DIRECTIONS
  • Catapult\MESSAGE_STATES
  • Catapult\NUMBER_STATES
  • Catapult\PATHS
  • Catapult\PLAYBACK_STATES
  • Catapult\RECORDING_STATES
  • Catapult\RECORDING_STATUSES
  • Catapult\SPEAK_STATES
  • Catapult\TRANSCRIPTION_STATES
  • Catapult\WARNINGS

Exceptions

  • CatapultApiException

Functions

  • includeDir
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 
<?php
namespace Catapult;
/**
 * Quick prototypes for RESTClient
 * allow get/create/update/patch
 * to be mocked and dynamically defined
 *  
 *
 * Input should always guarantee atleast two
 * parameters. term and object
 */
class PrototypeUtility extends BaseUtilities {

    public function get_idx($args, $idx) {
      return $args[$idx];
    }
    /**
     * Get this from a static
     * context. Will be used
     * for the other methods.
     * last parameter should be the object
     *
     * @param args: func_get_args
     */
    public static function get_this($args) 
    {
      return self::get_idx($args, sizeof($args) - 1);
    }

    /**
     * get the term
     * associated with
     * this subfunction
     * should be a valid term 
     * in Catapult models
     *
     * @param args: func_get_args
     */
    public function get_term($args)
    {
      return self::get_idx($args, sizeof($args) - 2);
    }

    /**
     * IDs for subfunctions
     * can be found in the first
     * parameter
     *  
     * @param args: func_get_args
     */
    public function get_id($args)
    {
      return self::get_idx($args, 0);
    }

    /**
     * IDs for subfunctions
     * can be found in the first
     * parameter
     *
     * @param args: func_get_args
     */
    public function get_is_plural($args)
    {
      return self::get_idx($args, 1);
    }


    /**
     * Mock get functions
     * read whether we need to 
     * use an id or not
     * then run accordingly
     * last parameter will always
     * be 'this' object
     */
    public static function get()
    {
       $args = func_get_args();
       
       $that = self::get_this($args);
       $term = self::get_term($args);
       $id = self::get_id($args);
       $plural = self::get_is_plural($args);

       if ($plural) {
         $url = URIResource::Make($that->path, array($that->id, GenericResource::getPath($term)));
         $dp = new DataPacketCollection($that->client->get($url));
         $cl = GenericResource::getObjClass($term);
         $pobjcl = "Catapult\\" . $cl . "Collection";
         $pobj = new $pobjcl($dp);
               
         return $pobj;
       } else {
         $url = URIResource::Make($that->path, array($that->id, GenericResource::getPath($term)));
         $dp = new DataPacket($that->client->get($url));
         $cl = GenericResource::getObjClass($term);
         $pobjcl = "Catapult\\" . $cl;
         $pobj = new $pobjcl;

         return Constructor::Make($pobj, $dp->get());
       }


       return Constructor::Make($pobj, $dp->get());
    }

    /**
     * prototypal add. This needs
     * term to be set as a function 
     * in its caller it will be used
     * to initialize the resulting
     * object
     *
     * Conference->addMember 
     * should return
     * ConferenceMember
     *
     * @params: mix of function arguments as well as object prototypes, terms
     */
    public static function add(/** polymorphic **/)
    {
       $args = func_get_args();
       $that = self::get_this($args);
       $term = self::get_term($args);

       $url = URIResource::Make($that->path, array($that->id, $term));

       $id = Locator::Find($that->client->post($url, $args->get()));
        
       return $this->$term($id);
    }

    /**
     * Prototypal update.
     * must have sub id to reference
     * allows mocking
     * of functions like: 
     *
     * Conference->updateMember(array(memberId=1))
     *
     * termId should always be
     * term + Id
     * make sure it is singular.
     *
     */
    public static function update(/** polymorphic **/)
    {
      $args = func_get_args();
      $that = self::get_this($args);
      $term = self::get_term($args);
      $data = Ensure::Input($args);
      $termId = TitleUtility::ToSingular($term) . "Id";

      $ret = $this->client->post($url, array($term, $data->get($termId)));

      return $this->$term($ret['id']);
    }

}
Bandwidth PHP SDK API documentation generated by ApiGen