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 XMLUtility

Base functions for dealing with responses, headers content and internal type handling

Catapult\BaseUtilities
Extended by Catapult\XMLUtility
Final
Namespace: Catapult
Located at utils/XML.php

Methods summary

public
# Make( XML & $baml, $values = null )

Takes a struct of one dimensional XML elements and makes them a BaML tree

Takes a struct of one dimensional XML elements and makes them a BaML tree

Provided object must have its validating method available

Parameters

$baml
struct
$values

Returns

BaMLResource
public
# MakePred( $xml )

make without baML schema. Really just used for tests

make without baML schema. Really just used for tests

public static
# getHeader( )

Default header for baML will set encoding based on XMLUtility static class

Default header for baML will set encoding based on XMLUtility static class

render using the default encoding

public static
# open( $tag, $baml = false )

default open for baML verb

default open for baML verb

public static
# fullOpen( $tag, $baml = false )

a full open tag for the BaML document optionally checks if its valid

a full open tag for the BaML document optionally checks if its valid

public static
# close( $tag, $baml = false )

a close tag for the BaML document optionally checks if its valid

a close tag for the BaML document optionally checks if its valid

public static
# fullClose( $tag, $baml = false )

a full close tag for BaML optionally checks if its valid

a full close tag for BaML optionally checks if its valid

public static
# getAttributesCollection( attributes: $attributes, $padding = 1 )

gets the attribute collection as a string

gets the attribute collection as a string

Parameters

$attributes
[array]
$padding
public static
# joinTree( verbs: $verbs )

simple xml join tree sax wrapper around PHP's XML parser does not provide

simple xml join tree sax wrapper around PHP's XML parser does not provide

Parameters

$verbs
[array]
public
# openTag( name: $name, $attributes = null )

open tag for a BaML document. will join attributes if available

open tag for a BaML document. will join attributes if available

Parameters

$name
BaML verb
$attributes
public
# closeTag( $name )

close tag for BaML document. Stub, see full close

close tag for BaML document. Stub, see full close

public static
# indent( xml: $xml )

Pretty print the XML document. Preserve spacing tab at every newline

Pretty print the XML document. Preserve spacing tab at every newline

Parameters

$xml
document
public static
# parse( element: $element )

parse a singular element and return its pieces as either an attribute, verb or text

parse a singular element and return its pieces as either an attribute, verb or text

Parameters

$element
element

Methods inherited from Catapult\BaseUtilities

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

Properties summary

public static array $options

Basic options for XML utility. XML document encoding and other options should be set from setOption/1

Basic options for XML utility. XML document encoding and other options should be set from setOption/1

# array( "header" => '<?xml version="1.0" encoding="UTF-8"?>', "encoding" => "UTF-8" )
Bandwidth PHP SDK API documentation generated by ApiGen