command:studio

studioStartDebug

studioStartDebug --eventsGroupId= [--noRemote=] [--overrideHost=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Start a debug session for a specific issue.

  • --eventsGroupId
    The issue event group identifier.
  • --noRemote
    Use the server's own local files for debug display. Default: true. Setting it to false will use local files from studio if available.
  • --overrideHost
    Override the host address sent to Zend Server for initiating a Debug session. This is used to point Zend Server at the right address where Studio is executed.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

studioStartProfile

studioStartProfile --eventsGroupId= [--overrideHost=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Start a profiling session with Zend Studio's integration using an event-group's identifier.

  • --eventsGroupId
    The issue event group identifier.
  • --overrideHost
    Override the host address sent to Zend Server for initiating a Debug session. This is used to point Zend Server at the right address where Studio is executed.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

studioShowSource

studioShowSource --eventsGroupId= [--overrideHost=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Show source of a file that triggered an error event.

  • --eventsGroupId
    The issue event group identifier.
  • --overrideHost
    Override the host address sent to Zend Server for initiating a Debug session. This is used to point Zend Server at the right address where Studio is executed.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

studioStartDebugMode

studioStartDebugMode --filters= [--options=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Start debug mode on the target server. Note that if this server is a member of a cluster, it will modify its own directive only and will not affect the rest of the cluster. When checking the cluster management UI, a notification may be displayed to show that this particular server deviates from the cluster blueprint of directive values, this is normal.

  • --filters
    Non empty array with filters.
  • --options
    Debugging options.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

studioStopDebugMode

studioStopDebugMode [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Stop debug mode on the target server. Note that if this server is a member of a cluster, it will modify its own directive only and will not affect the rest of the cluster. When checking the cluster management UI, a notification may be displayed to show that this particular server deviates from the cluster blueprint of directive values, this is normal. Starting and stopping debug mode requires a restart of the user’s PHP server and happens in an asynchronous process. Perform polling in several steps:

  1. Poll until the server requires a restart, which signals the directive change operation was successful.
  2. Call restartPhp action.
  3. Poll until the server no longer requires a restart at which point the server is fully operational in debug mode.

  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

studioIsDebugModeenabled

studioIsDebugModeenabled [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Return the current debug mode status on the server.

  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.