Service

Base class for Webservice Hooks.

Use Service::setupMethods to define the available methods and define a public function for each method.

This function will be called with the defined input parameters.

Example

<?php
// Your module is in <XELOS root>/vendor/example/modules/my_module, e.g. created with:
// > php xf kickstart example/my_module
// The Service implementation is in the folder hook/webservice of your module.
// Register your hook in the module's config.yml (remove the #):

#provided_hooks:
#  hello: {hook: webservice.service, type: object, internal: no, active: yes, title: 'Hello Service', desc: 'Greet the developer'}

namespace XELOS\Vendor\Example\Modules\MyModule\Hook\Webservice;

use XELOS\Framework\XF;
use XELOS\Modules\Webservice\Hook\Base\Service;
use XELOS\Modules\Webservice\Hook\Base\Service\Method;
use XELOS\Modules\Webservice\Hook\Base\Service\Types;

class HelloService extends Service {
    // The implementation of v2 supports the greeting parameter
    public function hello($name = 'World', $greeting = 'Hello') {
        $XF = XF::instance();
        $name = $XF->lib->sec->input($name) ?: 'World';
        $greeting = $XF->lib->sec->input($greeting) ?: 'Hello';
        return "{$greeting}, {$name}";
    }

    public function complexGreeting($greetingHash = []) {
        $XF = XF::instance();

        $parameters = $greetingHash;
        // The WSDL definition of the complex types is interpreted as an array of associative arrays.
        // The first entry and only entry is our defined input type $helloInput from HelloService::init
        if (\is_array($greetingHash) && \count($greetingHash) === 1) {
            $parameters = \array_pop($parameters);
        }
        // Extract the values from the input
        [
            'greeting'    => $greeting,
            'name'        => $name,
            'punctuation' => $punctuation
        ] = $parameters;
        $punctuation = $XF->lib->sec->input($punctuation) ?: '';

        return $this->hello($name, $greeting) . $punctuation;
    }

    public function setupMethods(): array {
        // Just a simple return with no inputs.
        $hiMethod = new Method('hi');
        $hiMethod->addOutputParameter('greeting', Types::STRING);
        $hiMethod->setCallback(function () {
            return 'Hi';
        });

        $helloMethod = new Method('hello');
        $helloMethod->addInputParameter('name', Types::STRING);
        $helloMethod->addOutputParameter('greeting', Types::STRING);

        // Extended the hello method with a greeting parameter
        $helloMethod->addInputParameter('greeting', Types::STRING)
                                ->setCallback([$this, 'hello']);
        // Register version 2, the public function expects a v2 suffix.
        $helloMethodV2 = clone $helloMethod;
        $helloMethodV2->setVersion(2);

        $complexMethod = new Method('another_greeting');
        // You can define objects / hashes as input and output parameters
        $helloInput = new Service\ParameterObject();
        $helloInput->addMember('greeting', Types::STRING);
        $helloInput->addMember('name', Types::STRING);
        $helloInput->addMember('punctuation', Types::STRING);
        $complexMethod->addInputParameter('greetingHash', Types::OBJECT, $helloInput);
        $complexMethod->addOutputParameter('greeting', Types::STRING);
        $complexMethod->setCallback([$this, 'complexGreeting']);

        return [$helloMethod, $helloMethodV2, $complexMethod];
    }
}