Create, Update & Delete Examples about webservice HOT 12 OPEN

<?php

// Think of the endpoint like a entity

namespace Example\Newspaper\Webservice;

use Muffin\Webservice\Model\Endpoint;
use Muffin\Webservice\Schema;

class NewspaperArticlesEndpoint extends Endpoint
{
    /**
     * Initialise Method
     *
     * @param array $config Array of config
     * @return void
     */
    public function initialize(array $config)
    {
        parent::initialize($config);

        // The primary key in which data is handled
        $this->primaryKey('id');
        $this->displayField('name');

        // Just like an entity this is the data the remote webservice expects.
        $schema = new Schema(null, [
            'id' => [
                'type' => 'integer',
            ],
            'name' => [
                'type' => 'string',
            ],
            'contents' => [
                'type' => 'string',
            ],
        ]);
        $this->schema($schema);
    }
}

<?php

// I have not implemented any resources, I believe it is the response
// the endpoint may provide back?

namespace Example\Newspaper\Model\Resource;

use Muffin\Webservice\Model\Resource;

/**
 * Class NewspaperArticle
 *
 * @package Example\Newspaper\Model\Resource
 */
class NewspaperArticle extends Resource
{

}

<?php

namespace Example\Newspaper\Webservice;

use Muffin\Webservice\Query;
use Muffin\Webservice\Webservice\Webservice;
use Psr\Http\Message\ResponseInterface;

/**
 * Class NewspaperWebservice
 *
 * @package Example\Newspaper\Webservice
 */
class NewspaperWebservice extends Webservice
{
    /**
     * Execute Create Query Method
     */
    protected function _executeCreateQuery(Query $query, array $options = [])
    {
        // This is the main webservice endpoint, in my example I'm assuming that 
        // there is something already operating here and it is different structure
        // to the articles webservice. In other words check NewspaperArticlesWebservice.php
    }

    /**
     * Execute Read Query Method
     */
    protected function _executeReadQuery(Query $query, array $options = [])
    {
        // As above check NewspaperArticlesWebservice.php
    }

    /**
     * Check Response Method
     */
    protected function _checkResponse(ResponseInterface $response)
    {
        // Globally handle 404s etc
    }

    /**
     * Execute Update Query Method
     */
    protected function _executeUpdateQuery(Query $query, array $options = [])
    {
        // As above check NewspaperArticlesWebservice.php
    }

    /**
     * Execute Delete Query Method
     */
    protected function _executeDeleteQuery(Query $query, array $options = [])
    {
        // As above check NewspaperArticlesWebservice.php
    }
}

<?php

namespace Example\Newspaper\Webservice;

use Cake\Network\Http\Response;
use Muffin\Webservice\Model\Endpoint;
use Muffin\Webservice\Query;

/**
 * Class NewspaperArticlesWebservice
 *
 * @package Example\Newspaper\Webservice
 */
class NewspaperArticlesWebservice extends NewspaperWebservice
{
    /**
     * Initialise Method
     *
     * @return void
     */
    public function initialize()
    {
        parent::initialize();
    }

    /**
     * Execute Create Query Method
     */
    protected function _executeCreateQuery(Query $query, array $options = [])
    {
        // Query->set will initiate the schema created set out in the endpoint,
        // if missing wont map/create (just like entity)
        $parameters['article'] = $query->set();

        /* @var Response $response */
        $response = $this->driver()->client()->post($this->_baseUrl(), json_encode($parameters), ['type' => 'json']);

        $this->_checkResponse($response);

        return $this->_transformResource($query->endpoint(), $response->json);
    }

    /**
     * Base URL
     */
    protected function _baseUrl()
    {
        return '/articles';
    }

    /**
     * Transform Resource Method
     */
    protected function _transformResource(Endpoint $endpoint, array $result)
    {
        // Deal with the article data returned.
    }

    /**
     * Read Query Method
     */
    protected function _executeReadQuery(Query $query, array $options = [])
    {
        // ...
    }

    /**
     * Update Query Method
     */
    protected function _executeUpdateQuery(Query $query, array $options = [])
    {
        // Query->set will initiate the schema created set out in the endpoint,
        // if missing wont map/create (just like entity)
        $parameters['article'] = $query->set();
        $parameters['article'][$query->endpoint()->primaryKey()] = $query->where()['id'];

        /* @var Response $response */
        $response = $this->driver()->client()->post($this->_baseUrl(), json_encode($parameters), ['type' => 'json']);

        $this->_checkResponse($response);

        return $this->_transformResource($query->endpoint(), $response->json);
    }

    /**
     * Delete Query Method
     */
    protected function _executeDeleteQuery(Query $query, array $options = [])
    {
        // I have not tried a delete
    }
}

<?php

namespace App\Controller;

use App\Controller\AppController;
use Cake\Event\Event;
use Cake\ORM\TableRegistry;

/**
 * Newspaper Articles Controller
 *
 * @property \Exammple\Newspaper\Model\Endpoint\NewspaperArticlesEndpoint $NewspaperArticles
 */
class NewspaperArticlesController extends AppController
{
    /**
     * @throws \Exception
     * @return void
     */
    public function initialize()
    {
        parent::initialize();

        $this->modelFactory('Endpoint', ['Muffin\Webservice\Model\EndpointRegistry', 'get']);
    }

    /**
     * Before Filter Method
     *
     * @param \Cake\Event\Event $event Event Object
     *
     * @return \Cake\Http\Response|null|void
     */
    public function beforeFilter(Event $event)
    {
        $this->loadModel('Example/Newspaper.NewspaperArticles', 'Endpoint');
    }

    /**
     * Add the article from Cake to Newspaper Article Web Service
     *
     * @param string|null $articleId The local article id
     *
     * @return \Cake\Http\Response|null
     */
    public function add($articleId = null)
    {
        // In my example, Im populating data from another table and saving (adding/pushing) 
        // that into a remote system using the webservice plugin. You may not wish to do 
        // that, in which case you could just post the data from your form to the remote 
        // webservice and skip loading data.

        // Pull in the data from the articles table (your local data in cake).
        $article = TableRegistry::getTableLocator()->get('Articles');
        $myArticle = $article->get($articleId);

        if (!$myArticle->id) {
            $this->Flash->error(__('This article doesn\'t exist'));

            return $this->redirect($this->referer());
        }

        // Initiate the new remote article (creates from endpoint schema)
        $newspaperArticle = $this->NewspaperArticles->newEntity();

        // The minimum to create an article on remote system.
        $articleData = [
            'name' => $myArticle->name,
            'contents' => $myArticle->contents,
        ];

        // Patch the endpoint with the data to be saved to remote system.
        $newspaperArticle = $this->NewspaperArticles->patchEntity($newspaperArticle, $articleData);

        $newspaperResponse = $this->NewspaperArticles->save($newspaperArticle);

        if ($newspaperResponse->id) {
            $this->Flash->success(__('The article has been created in the remote system.'));

            // here you may choose to save any of the data the remote system responded with
        } else {
            $this->Flash->error(__('The article has not been created in the remote system'));
        }

        return $this->redirect($this->referer());
    }

    public function edit($articleId = null)
    {
        // An edit would follow similar approach to above. Sorry once I found out that
        // magento didn't require me to separate and edit from an add, I just post everything 
        // to a create method and Magento handles if needs to create or update.
    }
}