Studio-Integration Methods

The following is a list of methods available for the Studio-Integration feature:

  • studioStartDebug
  • studioStartProfile
license New BSD License
link for the canonical source repository
author Ingo Walz
category Zend
package Zend_Service
subpackage ZendServerAPI

 Methods

Base constructor for all API-method implementations

__construct(string $name) 
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::__construct()

Parameters

$name

string

Name of the config

Check if connection is possible or not

canConnect() : bool
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::canConnect()

Returns

bool

Disables the logging

disableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::disableLogging()

Enables the logging

enableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::enableLogging()

Get the plugin manager

getPluginManager() : \Zend\ServiceManager\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getPluginManager()

Returns

\Zend\ServiceManager\PluginManager

Returns the current request

getRequest() : \ZendService\ZendServerAPI\Request
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getRequest()

Returns

Set the client.

setClient(\Zend\Http\Client $client) : void
Inherited

Most likly for testing

inherited_from \ZendService\ZendServerAPI\BaseAPI::setClient()

Parameters

$client

\Zend\Http\Client

Set the config file.

setConfigFile(string $configFile) : void
Inherited

Proxy to the pluginmanager for initialization

inherited_from \ZendService\ZendServerAPI\BaseAPI::setConfigFile()

Parameters

$configFile

string

Set the request for the current context

setRequest(\ZendService\ZendServerAPI\Request $request) : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::setRequest()

Parameters

<b>The studioStartDebug Method</b>

studioStartDebug(string $issueId, string $eventsGroupId, string $noRemote, string $overrideHost) : \ZendService\ZendServerAPI\DataTypes\DebugRequest
Start a debug session for a specific issue

Parameters

$issueId

string

The issue identifier

$eventsGroupId

string

The issue event group identifier

$noRemote

string

Use server's own local files for debug display. Default: true. Setting to false will use local files from studio if available

$overrideHost

string

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

Returns

<b>The studioStartProfile Method</b>

studioStartProfile(string $issueId, string $eventsGroupId, string $overrideHost) : \ZendService\ZendServerAPI\DataTypes\DebugRequest
Start a profiling session with Zend Studio's integration
using an events group identifier

Parameters

$issueId

string

The issue identifier

$eventsGroupId

string

The issue event group identifier

$overrideHost

string

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

Returns

Get the first event groups identifier by an given issue id.

getFirstEventGroupsIdByIssueId(int $issueId) : int
Inherited

This will perform an monitorGetIssuesDetails action.

inherited_from \ZendService\ZendServerAPI\BaseAPI::getFirstEventGroupsIdByIssueId()

Parameters

$issueId

int

Returns

int

 Properties

 

$name : string
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$name
 

$pluginManager : \ZendService\ZendServerAPI\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$pluginManager