Class BaMLVerb

Catapult\BaMLVerb

Direct known subclasses

Catapult\BaMLVerbGather, Catapult\BaMLVerbHangup, Catapult\BaMLVerbPlayAudio, Catapult\BaMLVerbRecord, Catapult\BaMLVerbRedirect, Catapult\BaMLVerbSendMessage, Catapult\BaMLVerbSpeakSentence, Catapult\BaMLVerbTransfer

Indirect known subclasses

Catapult\BaMLGather, Catapult\BaMLHangup, Catapult\BaMLPlayAudio, Catapult\BaMLRedirect, Catapult\BaMLSendMessage, Catapult\BaMLSpeakSentence, Catapult\BaMLTransfer

Namespace: Catapult
Located at baml/BaMLVerb.php

Methods summary

`public`	# `__construct( )` Get the verb's class name and provide it's schema. Get the verb's class name and provide it's schema. when we have an invalid verb we should warn
`public`	# `fromString( $verb )` BaML object from a given string where string is a legal verb name BaML object from a given string where string is a legal verb name
`public`	# `__toString( )` BaML Object in string form BaML Object in string form
`public`	# `create( data $arg )` similar to public api functions. create takes accepted input as per (ensureResource) and will form the object from it similar to public api functions. create takes accepted input as per (ensureResource) and will form the object from it Parameters `$arg`
`public`	# `hasVerbs( )` are there nested verbs? are there nested verbs?
`public`	# `getVerbs( )` get the nested verbs get the nested verbs
`public`	# `getName( )` get the verb's name get the verb's name
`public`	# `getAttributes( )` get all a verb's attributes get all a verb's attributes
`public`	# `getAttributesString( )` get the attributes in one string get the attributes in one string
`public`	# `getText( )` get the text the verb get the text the verb Overrides `Catapult\BaMLGeneric::getText`
`public`	# `addVerb( verb: $verb )` add one verb to another unless unapplicable add one verb to another unless unapplicable Parameters `$verb` BaMLVerb
`public`	# `addNestedVerb( index: $index, verb: $verb )` adds a nested verb to one of this verb's children adds a nested verb to one of this verb's children Parameters `$index` lower and upper `$verb` verb
`public`	# `addNestedText( $index, $text )` adds text to a nested verb adds text to a nested verb
`public`	# `setNestedText( $index, $text )`
`public`	# `addNestedAttribute( $index, $attribute )` add a nested attribute add a nested attribute
`public`	# `addNestedAttributes( $index, $attribute )`
`public`	# `addAttribute( attribute: $attribute )` adds an attribute to the verb. adds an attribute to the verb. Parameters `$attribute` \| tuple parameter \| BaMLAttribute
`public`	# `printAttributes( )`
`public`	# `addAttributes( $attributes )` add attributes in multi form * add attributes in multi form *
`public`	# `addText( Catapult\BaMLVerb::$text $text )` add text. This will append add text. This will append Parameters `$text` Overrides `Catapult\BaMLGeneric::addText`
`public`	# `countVerbs( )` counts all the verbs counts all the verbs
`public`	# `getNestedVerb( $index )` gets a nested verb gets a nested verb
`public`	# `getLevel( )` What level was this verb found on. It is relative to the BaML parsed document What level was this verb found on. It is relative to the BaML parsed document
`public`	# `getNestedNestedVerb( $index )` in some cases, for the xml generation we need a nested verbs nested in some cases, for the xml generation we need a nested verbs nested
`public`	# `setText( $text )` Overrides `Catapult\BaMLGeneric::setText`

Properties summary

`public static array`	`$valid` use constants here for clarity, and ability to interchange * use constants here for clarity, and ability to interchange *	# `array( BAML_VERBS::BAML_SPEAK_SENTENCE, BAML_VERBS::BAML_PLAY_AUDIO, BAML_VERBS::BAML_TRANSFER, BAML_VERBS::BAML_GATHER, BAML_VERBS::BAML_RECORD, BAML_VERBS::BAML_SEND_MESSAGE, BAML_VERBS::BAML_REDIRECT, BAML_VERBS::BAML_HANGUP, )`
`public array`	`$constraints` constraints should be by objects * constraints should be by objects *	# `array( )`
`public static array`	`$params`	# `array( )`
`public`	`$text` text of BaML object * text of BaML object *	# `null`
`public array`	`$verbs` flat array of verbs for this verb * flat array of verbs for this verb *	# `array( )`

Namespaces

Classes

Interfaces

Class BaMLVerb

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Overrides

Parameters

Parameters

Parameters

Parameters

Overrides

Overrides

Properties summary