CWebServiceAction

Property Details

classMap property

public array $classMap;

a list of PHP classes that are declared as complex types in WSDL. This should be an array with WSDL types as keys and names of PHP classes as values. A PHP class can also be specified as a path alias.

provider property

public mixed $provider;

the Web service provider object or class name. If specified as a class name, it can be a path alias. Defaults to null, meaning the current controller is used as the service provider. If the provider implements the interface IWebServiceProvider, it will be able to intercept the remote method invocation and perform additional tasks (e.g. authentication, logging).

service property read-only

public CWebService getService()

Returns the Web service instance currently being used.

serviceOptions property

public array $serviceOptions;

the initial property values for the CWebService object. The array keys are property names of CWebService and the array values are the corresponding property initial values.

serviceUrl property

public string $serviceUrl;

the URL for the Web service. Defaults to null, meaning the URL for this action is used to provide Web services. In this case, a GET parameter named serviceVar will be used to deteremine whether the current request is for WSDL or Web service.

serviceVar property

public string $serviceVar;

the name of the GET parameter that differentiates a WSDL request from a Web service request. If this GET parameter exists, the request is considered as a Web service request; otherwise, it is a WSDL request. Defaults to 'ws'.

wsdlUrl property

public string $wsdlUrl;

the URL for WSDL. Defaults to null, meaning the URL for this action is used to serve WSDL document.

Method Details

createWebService() method

protected CWebService createWebService(mixed $provider, string $wsdlUrl, string $serviceUrl)

protected function createWebService($provider,$wsdlUrl,$serviceUrl)
{
    return new CWebService($provider,$wsdlUrl,$serviceUrl);
}

Creates a CWebService instance. You may override this method to customize the created instance.

getService() method

public CWebService getService()

public function getService()
{
    return $this->_service;
}

Returns the Web service instance currently being used.

run() method

public void run()

public function run()
{
    $hostInfo=Yii::app()->getRequest()->getHostInfo();
    $controller=$this->getController();
    if(($serviceUrl=$this->serviceUrl)===null)
        $serviceUrl=$hostInfo.$controller->createUrl($this->getId(),array($this->serviceVar=>1));
    if(($wsdlUrl=$this->wsdlUrl)===null)
        $wsdlUrl=$hostInfo.$controller->createUrl($this->getId());
    if(($provider=$this->provider)===null)
        $provider=$controller;

    $this->_service=$this->createWebService($provider,$wsdlUrl,$serviceUrl);

    if(is_array($this->classMap))
        $this->_service->classMap=$this->classMap;

    foreach($this->serviceOptions as $name=>$value)
        $this->_service->$name=$value;

    if(isset($_GET[$this->serviceVar]))
        $this->_service->run();
    else
        $this->_service->renderWsdl();

    Yii::app()->end();
}

Runs the action. If the GET parameter serviceVar exists, the action handle the remote method invocation. If not, the action will serve WSDL content;