Protocol/Client.to.Script

breakpoint

NAME. 

breakpoint

ARGS. 

  • type - either "line", "change" or "true", ie break on a line, changed expression or when expression is true

  • filename - (conditional/line) for line breakpoints this is the file where the breakpoint should be located/occur, for conditional breakpoints it's an optional filename and halting will only occur if execution is currently in that file

  • line - (line) what line the breakpoint is at

  • class - (conditional) only break if the condition is true and in a method of an object of this class (optional)

  • function - (conditional) only break if the condition is true and in a function name like this (optional)

  • expression - (conditional) what expression to evaluate, for example ($a == 12)

DESCRIPTION. 

breakpoint tells the sctipt to set a breakpoint in the specified file on the specified line, or to add a conditional breakpoint with the specified expression.

The script might reply with a removebreakpoint command in case the breakpoint is not ok

SEE ALSO. 

removebreakpoint

die

NAME. 

die

ARGS. 

none

DESCRIPTION. 

Tells the script to die. Execution will stop immediately.

SEE ALSO. 

pause

getvariable

NAME. 

getvariable

ARGS. 

  • variable - expression to get value of, for example "$t"

DESCRIPTION. 

Requests the value/result of an expression

SEE ALSO. 

getwatch

getwatch

NAME. 

getwatch

ARGS. 

DESCRIPTION. 

Requests the value of a watch

SEE ALSO. 

getvariable

havesource

NAME. 

havesource

ARGS. 

none

DESCRIPTION. 

During initialization, the client tells the script what file is to be entered and the client responds with a 'havesource' if it already knows about the source of the file.

SEE ALSO. 

initialize, sendsource

next

NAME. 

next

ARGS. 

none

DESCRIPTION. 

Tells the script to execute the next instruction and proceed to the next one. This command will step into function calls and include files.

SEE ALSO. 

stepover, skip, stepout

pause

NAME. 

pause

ARGS. 

none

DESCRIPTION. 

Tells the script to halt and await further commands

SEE ALSO. 

trace, run

processphp

NAME. 

processphp

ARGS. 

command - php commands to process

DESCRIPTION. 

Tells the script to execute a few php commands and return the result

SEE ALSO. 

getwatch, getvariable

reinitialize

NAME. 

reinitialize

ARGS. 

none

DESCRIPTION. 

Tells the script to reinitialize, the client can request this action if it was closed down and reopened during script execution (can happen when the proxy is used) Or if the script tells the client to show a line that it doesent know of (and the source can't be loaded form disk)

SEE ALSO. 

initialize

removebreakpoint

NAME. 

removebreakpoint

ARGS. 

  • type - either "line", "change" or "true", ie break on a line, changed expression or when expression is true

  • filename - (conditional/line) for line breakpoints this is the file where the breakpoint should be located/occur, for conditional breakpoints it's an optional filename and halting will only occur if execution is currently in that file

  • line - (line) what line the breakpoint is at

  • class - (conditional) only break if the condition is true and in a method of an object of this class (optional)

  • function - (conditional) only break if the condition is true and in a function name like this (optional)

  • expression - (conditional) what expression to evaluate, for example ($a == 12)

DESCRIPTION. 

Removes a breakpoint

SEE ALSO. 

breakpoint

run

NAME. 

run

ARGS. 

none

DESCRIPTION. 

Tells the script to execute as fast as possible. Watches and current position won't be updated until the script is paused or it enters trace mode.

SEE ALSO. 

trace, pause

sendactiveline

NAME. 

sendactiveline

ARGS. 

none

DESCRIPTION. 

Tells the script to send the currently active file and line

SEE ALSO. 

sendallvariables

NAME. 

sendallvariables

ARGS. 

none

DESCRIPTION. 

Tells the script to send the current scope

SEE ALSO. 

sendbacktrace

NAME. 

sendbacktrace

ARGS. 

none

DESCRIPTION. 

Tells the script to send the current backtrace

SEE ALSO. 

sendprotocolversion

NAME. 

sendprotocolversion

ARGS. 

none

DESCRIPTION. 

Tells the script to send it's protocol version

SEE ALSO. 

protocolversion

sendsource

NAME. 

sendsource

ARGS. 

  • filename - what source is requested

DESCRIPTION. 

During initialization, the client tells the script what file is to be entered and the client responds with a 'sendsource' if it wants the script to send the sourcecode of the file.

SEE ALSO. 

havesource

sentwatches

NAME. 

sentwatches

ARGS. 

key - some kind of key that needs to be returned. hmm..

DESCRIPTION. 

The script confirms that all watches were received

SEE ALSO. 

setdisplaydelay

NAME. 

setdisplaydelay

ARGS. 

  • newdelay - new delay in ms to wait between each instruction in trace mode

DESCRIPTION. 

Set the display delay when in trace mode. Note that setting this to zero does not mean trace == run, trace will still be slower due to watch updates and other things.

SEE ALSO. 

run

seterrormask

NAME. 

seterrormask

ARGS. 

  • errormask - the type of errors that should halt execution

DESCRIPTION. 

Sets the errormask, a combination of * E_WARNING (2) * E_NOTICE (8) * E_USER_ERROR (256) * E_USER_WARNING (512) * E_USER_NOTICE (1024)

Other PHP error types are not handable

SEE ALSO. 

error, http://se.php.net/manual/en/ref.errorfunc.php#errorfunc.constants

setvariable

NAME. 

setvariable

ARGS. 

  • variable - varibale to change value of

  • value - new value

DESCRIPTION. 

Tells the script about an expression that needs to be executed. Mainly to set contents of variables.

SEE ALSO. 

skip

NAME. 

skip

ARGS. 

none

DESCRIPTION. 

Tells the script to skip the next instruction as if it wasn't there and move on to the next one.

SEE ALSO. 

next, stepover, stepout

stepout

NAME. 

stepout

ARGS. 

none

DESCRIPTION. 

Tells the script to execute the rest of the instructions in the current function or include file and halt again when it reaches the calling/including place.

SEE ALSO. 

next, skip, stepover

stepover

NAME. 

stepover

ARGS. 

none

DESCRIPTION. 

Tells the script to execute the next instruction and proceed to the next one. This command will not step into function calls and include files.

SEE ALSO. 

next, skip, stepout

trace

NAME. 

trace

ARGS. 

none

DESCRIPTION. 

Tells the script to constantly tell the client about the current line of execution and update watches, etc. As if the user was constantly pressing 'next'.

SEE ALSO. 

pause, run, setdisplaydelay

wait

NAME. 

wait

ARGS. 

none

DESCRIPTION. 

Tells te script to chill a bit

If in trace mode, the client will tell the script to 'wait' then 'next' upon receiving a 'commandme'

SEE ALSO.