CWebServiceAction

Подробное описание свойств

classMap свойство

public array $classMap;

список PHP-классов, объявленных как сложные типы в WSDL. Это должен быть массив, где ключами являются типы WSDL, а значениями — имена PHP-классов. PHP-класс также может быть указан как псевдоним пути.

provider свойство

public mixed $provider;

объект или имя класса поставщика веб-сервиса. Если указано как имя класса, это может быть псевдоним пути. По умолчанию значение null, что означает использование текущего контроллера в качестве поставщика услуг. Если поставщик реализует интерфейс IWebServiceProvider, он сможет перехватывать вызовы удалённых методов и выполнять дополнительные задачи (например, аутентификацию, ведение журналов).

service свойство только для чтения

public CWebService getService()

Возвращает экземпляр веб-службы, используемый в данный момент.

serviceOptions свойство

public array $serviceOptions;

начальные значения свойств для объекта CWebService. Ключи массива — имена свойств CWebService, а значения массива — соответствующие начальные значения свойств.

serviceUrl свойство

public string $serviceUrl;

URL веб-службы. По умолчанию null, что означает, что URL для этого действия используется для предоставления веб-служб. В этом случае, параметр GET с именем serviceVar будет использоваться для определения, предназначен ли текущий запрос для WSDL или веб-службы.

serviceVar свойство

public string $serviceVar;

имя параметра GET, который различает запрос WSDL от запроса веб-службы. Если этот параметр GET существует, запрос рассматривается как запрос веб-службы; в противном случае — как запрос WSDL. По умолчанию 'ws'.

wsdlUrl свойство

public string $wsdlUrl;

URL для WSDL. По умолчанию null, что означает, что URL для этого действия используется для предоставления документа WSDL.

Подробное описание методов

createWebService() метод

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

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

Создаёт экземпляр CWebService. Вы можете переопределить этот метод, чтобы настроить созданный экземпляр.

getService() метод

public CWebService getService()

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

Возвращает экземпляр веб-службы, используемый в данный момент.

run() метод

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();
}

Выполняет действие. Если параметр GET serviceVar существует, действие обрабатывает вызов удалённого метода. Если нет, действие предоставит содержимое WSDL;