subdee/yii2-soap-server

SOAP server for the Yii 2 framework based on the Yii 1 implementation

dev-master 2021-07-09 14:13 UTC

Requires

• ext-soap: *
• codeception/codeception: *
• roave/security-advisories: dev-master
• yiisoft/yii2: *

BSD-3-Clause

• soap
• server
• yii2

README

A SOAP server for Yii 2 based on the implementation of Yii 1 framework.

This extension is an adaptation of the SOAP Web Service available in Yii1, to Yii2. It contains features available up to v1.1.15.

Note: Things might not work as Yii2 progresses but I'll keep it updated as much as I can.

Requirements

• Yii2
• PHP SOAP

Installation

Use composer and add the following line to your composer.json file:

"subdee/yii2-soap-server": "*"

Usage

Usage is similar to the explanation in the Yii guide

Define the custom action in your controller:

public function actions()
{
    return [
        ...,
        'myService' => [
            'class' => 'subdee\soapserver\SoapAction',
        ],
        ...,
    ];
}

Add the @soap keyword to the properly documented actions you want:

/**
* Returns hello and the name that you gave
*
* @param string $name Your name
* @return string
* @soap
*/
public function getHello($name)
{
    return 'Hello ' . $name;
}

Also, remember to turn off CSRF validation for the controller by setting its property:

public $enableCsrfValidation = false;