Bandwidth PHP SDK
  • Namespace
  • Class

Namespaces

  • Catapult
  • None

Classes

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

Interfaces

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

Class DataPacket

Represent a of GenericOptions packed as an array each datapacket should have its Schema which is followed and used through the get/add/val methods

DataPacket is no more than a input based convinience that can be serialized into its needed form

Catapult\BaseUtilities
Extended by Catapult\DataPacket
Final
Namespace: Catapult
Object: DataPacket
Located at core/Collections.php

Methods summary

public
# __construct( $args )

A datapacket needs to 'cast' to string as some paramets maybe of Catapult api type

A datapacket needs to 'cast' to string as some paramets maybe of Catapult api type

Parameters

$args
collection of schema data
public
# get( strict $strict = FALSE )

Get the stored datapacket when this is done the data is considered to be dispatched

Get the stored datapacket when this is done the data is considered to be dispatched

Parameters

$strict

strict or not if it is data packet cant be retrieved twice.

public
# has( key $key )

check for membership in the data additionally chekc both data and data[0] as arguments can be polymorphic

check for membership in the data additionally chekc both data and data[0] as arguments can be polymorphic

Parameters

$key
a key in the data
public
# val( key $key, $obj = null )

Return a singular value from the data array

Return a singular value from the data array

Parameters

$key
single key [schema]
$obj
public
# add( key $key, Catapult\DataPacket::val() $val )

Set a single key for the schema

Set a single key for the schema

Parameters

$key
key [within schema]
$val
val
public
# is_empty( )

Is the data packet empty. If it is throw warning otherwise return false

Is the data packet empty. If it is throw warning otherwise return false

public
# is_string( )

is the data one in depth and string *

is the data one in depth and string *

public
# is_double_string( )

are both arguments strings this is when we get ('str', 'str') example Gather('call-id', 'gather-id')

are both arguments strings this is when we get ('str', 'str') example Gather('call-id', 'gather-id')

todo: simplify move logic into utilities keep it less verbose

public
# has_id( )
public
# __toString( )

Ready the packet for encoding where encoding should be set to the interop format

Ready the packet for encoding where encoding should be set to the interop format

Methods inherited from Catapult\BaseUtilities

assoc(), camelcase(), dateToApi(), datefromApi(), find(), is_multidimensional(), is_ref(), prop_or_arr(), same_type()

Bandwidth PHP SDK API documentation generated by ApiGen