• Inicio
• PAGI
• Node
• Node

PHP Class PAGI\Node\Node

Mostrar archivo Open project: marcelog/pagi Class Usage Examples

Protected Properties

Property	Type	Description
$state	integer	Node state.

Public Methods

Method	Description
__toString ( ) : string	A classic!
addPrePromptMessage ( string $filename ) : void	Adds a sound file to play as a pre prompt message.
cancelWith ( string $digit ) : Node	Configures a specific digit as the cancel digit.
cancelWithInputRetriesInput ( ) : Node	Allow the user to retry input by pressing the cancel digit after entered one or more digits. For example, when entering a 12 number pin, the user might press the cancel digit at the 5th digit to re-enter it. This counts as a failed input, but will not cancel the node. The node will be cancelled only if the user presses the cancel digit with NO input at all.
clearPromptMessages ( ) : Node	Removes prompt messages.
createValidatorInfo ( Closure $validation, string | null $soundOnError = null ) : validatorInfo	Given a callback and an optional sound to play on error, this will return a validator information structure to be used with validateInputWith().
delCustomData ( string $key ) : Node	Remove a key/value from the registry.
dontAcceptPrePromptInputAsInput ( ) : Node	Digits entered during the pre prompt messages are not considered as node input.
endInputWith ( string $digit ) : Node	Configures a specific digit as the end of input digit.
executeAfterFailedValidation ( Closure $callback ) : Node	Executes after the 1st failed validation.
executeAfterRun ( Closure $callback ) : Node	Executes after running the node.
executeBeforeRun ( Closure $callback ) : Node	Executes before running the node.
executeOnInputFailed ( Closure $callback ) : Node	Executes a callback when the node fails to properly get input from the user (either because of cancel, max attempts reached, timeout).
executeOnValidInput ( Closure $callback ) : Node	Specify a callback function to invoke when the user entered a valid input.
expectAtLeast ( integer $length ) : Node	Configure the node to expect at least this many digits. The input is considered complete when this many digits has been entered. Cancel and end of input digits (if configured) are not taken into account.
expectAtMost ( integer $length ) : Node	Configure the node to expect at most this many digits. The reading loop will try to read this many digits.
expectExactly ( integer $length ) : Node	Configure this node to expect at least and at most this many digits.
getClient ( ) : PAGI\Client\IClient	Returns the agi client in use.
getCustomData ( string $key ) : mixed	Returns the value for the given key in the registry.
getInput ( ) : string	Returns input.
getName ( ) : string	Returns the node name.
getTotalInputAttemptsUsed ( ) : integer	Returns the total number of input attempts used by the user.
hasCustomData ( string $key ) : boolean	True if the given key exists in the registry.
hasInput ( ) : boolean	True if this node has at least 1 digit as input, excluding cancel and end of input digits.
inputLengthIsAtLeast ( integer $length ) : boolean	True if this node has at least this many digits entered.
isComplete ( ) : boolean	True if this node is in COMPLETE state.
isTimeout ( ) : boolean	True if this node is in TIMEOUT state.
loadValidatorsFrom ( array $validatorsInformation ) : Node	Given an array of validator information structures, this will load all validators into this node.
maxAttemptsForInput ( integer $number ) : Node	Specify a maximum attempt number for the user to enter a valid input.
maxInputsReached ( ) : boolean	True if the user reached the maximum allowed attempts for valid input.
maxTimeBetweenDigits ( integer $milliseconds ) : Node	Configures the maximum time available between digits before a timeout.
maxTotalTimeForInput ( integer $milliseconds ) : Node	Configures the maximum time available for the user to enter valid input per attempt.
playNoInputMessageOnLastAttempt ( ) : Node	Forces to play "no input" message on last attempt too.
playOnMaxValidInputAttempts ( string $filename ) : Node	Optional message to play when the user exhausted all the available attempts to enter a valid input.
playOnNoInput ( string $filename ) : Node	Specify an optional message to play when the user did not enter any input at all. By default, will NOT be played if this happens in the last allowed attempt.
prePromptMessagesNotInterruptable ( ) : Node	Make pre prompt messages not interruptable
run ( ) : Node	Executes this node.
saveCustomData ( string $key, mixed $value ) : Node	Saves a custom key/value to the registry.
sayDateTime ( integer $timestamp, string $format ) : Node	Loads a prompt message for saying a date/time expressed by a unix timestamp and a format.
sayDigits ( integer $digits ) : Node	Loads a prompt message for saying the digits of the given number.
sayNumber ( integer $number ) : Node	Loads a prompt message for saying a number.
saySound ( string $filename ) : Node	Loads a prompt message for playing an audio file.
setAgiClient ( PAGI\Client\IClient $client ) : Node	Sets the pagi client to use by this node.
setName ( string $name ) : Node	Gives a name for this node.
unInterruptablePrompts ( ) : Node	Make prompt messages not interruptable.
validate ( ) : boolean	Calls all validators in order. Will stop when any of them returns false.
validateInputWith ( string $name, Closure $validation, string | null $soundOnError = null ) : Node	Add an input validation to this node.
wasCancelled ( ) : boolean	True if this node is in CANCEL state.

Protected Methods

Method	Description
acceptInput ( string $digit ) : void	Process a single digit input by the user. Changes the node state according to the digit entered (CANCEL, COMPLETE).
addClientMethodCall ( ) : void	Internally used to execute prompt messages in the agi client.
addPrePromptClientMethodCall ( ) : void	Internally used to execute pre prompt messages in the agi client.
appendInput ( string $digit ) : void	Appends an input to the node input.
beforeOnInputFailed ( ) : void	Convenient hook to execute before calling the onInputFailed callback.
beforeOnValidInput ( ) : void	Convenient hook to execute before calling the onValidInput callback.
callClientMethod ( string $name, array $arguments = [] ) : PAGI\Client\Result\IResult	Call a specific method on a client.
callClientMethods ( methodInfo[] $methods, Closure $stopWhen = null ) : PAGI\Client\Result\IResult	Calls methods in the PAGI client.
clearPrePromptMessages ( ) : void	Internally used to clear pre prompt messages after being played.
doInput ( ) : void	Internally used to accept input from the user. Plays pre prompt messages, prompt, and waits for a complete input or cancel.
evaluateInput ( string $digit ) : integer	Returns the kind of digit entered by the user, CANCEL, END, NORMAL.
inputIsCancel ( string $digit ) : boolean	True if the digit matches the cancel digit.
inputIsEnd ( string $digit ) : boolean	True if the digit matches the end of input digit.
logDebug ( string $msg ) : void	Used internally to log debug messages
playPrePromptMessages ( ) : PAGI\Client\Result\IResult	Internally used to play all pre prompt queued messages. Clears the queue after it.
playPromptMessages ( ) : PAGI\Client\Result\IResult | null	Plays pre prompt messages, like error messages from validations.
resetInput ( ) : Node	Internally used to clear the input per input attempt. Also resets state to TIMEOUT.
stateToString ( integer $state ) : string	Maps the current node state to a human readable string.

Method Details

Property Details