Skip to content

Support for relationships urls #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dakota merged 2 commits into from
Aug 5, 2020
Merged

Support for relationships urls #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53d2739
Support relationships URLs for JSONAPI 1.0
geoidesic Aug 4, 2020
86b06c1
Create DocumentsRelationshipValidator.php
geoidesic Aug 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
323 changes: 323 additions & 0 deletions src/Actions/RelationshipsAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,323 @@
<?php
declare(strict_types=1);

namespace CrudJsonApi\Action;

use Cake\Http\Response;
use Crud\Error\Exception\ValidationException;
use Crud\Event\Subject;
use Crud\Traits\FindMethodTrait;
use Crud\Traits\RedirectTrait;
use Crud\Traits\SaveMethodTrait;
use Crud\Traits\SerializeTrait;
use Crud\Traits\ViewTrait;
use Crud\Traits\ViewVarTrait;
use Cake\ORM\Locator\LocatorAwareTrait;
use Crud\Action\BaseAction;
use Cake\Utility\Inflector;
use Cake\Utility\Hash;

/**
* Handles 'Edit' Crud actions
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
*/
class RelationshipsAction extends BaseAction
{
use FindMethodTrait;
use RedirectTrait;
use SaveMethodTrait;
use SerializeTrait;
use ViewTrait;
use ViewVarTrait;
use LocatorAwareTrait;

/**
* Default settings for 'edit' actions
*
* `enabled` Is this crud action enabled or disabled
*
* `findMethod` The default `Model::find()` method for reading data
*
* `view` A map of the controller action and the view to render
* If `NULL` (the default) the controller action name will be used
*
* `relatedModels` is a map of the controller action and the whether it should fetch associations lists
* to be used in select boxes. An array as value means it is enabled and represent the list
* of model associations to be fetched
*
* `saveOptions` Options array used for $options argument of patchEntity() and save method.
* If you configure a key with your action name, it will override the default settings.
*
* @var array
*/
protected $_defaultConfig = [
'enabled' => true,
'scope' => 'entity',
'findMethod' => 'all',
'saveMethod' => 'save',
'view' => null,
'relatedModels' => true,
'saveOptions' => [],
'messages' => [
'success' => [
'text' => 'Successfully updated {name}',
],
'error' => [
'text' => 'Could not update {name}',
],
],
'redirect' => [
'post_add' => [
'reader' => 'request.data',
'key' => '_add',
'url' => ['action' => 'add'],
],
'post_edit' => [
'reader' => 'request.data',
'key' => '_edit',
'url' => ['action' => 'edit', ['subject.key', 'id']],
],
],
'api' => [
'methods' => ['put', 'post', 'patch'],
'success' => [
'code' => 200,
],
'error' => [
'exception' => [
'type' => 'validate',
'class' => ValidationException::class,
],
],
],
'serialize' => [],
];

/**
* HTTP GET handler
*
* @param string|null $id Record id
* @return void
* @throws \Cake\Http\Exception\NotFoundException If record not found
*/
protected function _get(?string $id = null): void
{
$subject = $this->_subject();
$subject->set(['id' => $id]);
$subject->set(['entity' => $this->_findRecord($id, $subject)]);

$this->_trigger('beforeRender', $subject);
}

/**
* HTTP PUT handler
*
* @param string|null $id Record id
* @return \Cake\Http\Response|null
*/
protected function _put(?string $id = null)
{
$subject = $this->_subject();
$subject->set(['id' => $id]);

$entity = $this->_table()->patchEntity(
$this->_findRecord($id, $subject),
$this->_request()->getData(),
$this->saveOptions()
);

$this->_trigger('beforeSave', $subject);

if (call_user_func([$this->_table(), $this->saveMethod()], $entity, $this->saveOptions())) {
return $this->_success($subject);
}

$this->_error($subject);
}

/**
* HTTP DELETE handler
*
*
* @return \Cake\Http\Response|null
*/
protected function _delete()
{
$subject = $this->_subject();
$request = $this->_request();
$id = $request->getParam('id');
$foreignTableName = $request->getParam('foreignTableName');
$data = $request->getData();
$requestMethod = $request->getMethod();
$subject->set(['id' => $id]);
$this->_crud('Crud.Crud')->on('beforeFind', function (\Cake\Event\Event $event) use ($data, $foreignTableName, $requestMethod) {
$query = $event->getSubject()->query;
$query->contain(['Dishes']);
});
$entity = $this->_table()->patchEntity(
$this->_findRecord($id, $subject),
[],
$this->saveOptions()
);
if (empty((array)$data)) {
$entity->$foreignTableName = [];
} else {
$currentIds = Hash::extract($entity->$foreignTableName, '{n}.id');
$idsToDelete = Hash::extract($data, '{n}.id');
$entity->$foreignTableName = [];
$foreignTable = $this->getTableLocator()->get(Inflector::camelize($foreignTableName));
$foreignKey = $foreignTableName . '.id';
foreach ($currentIds as $key => $id) {
if (!in_array($id, $idsToDelete)) {
// get the record to add
$query = $foreignTable->findAllById($id);
$foreignRecord = $query->first();
if (!empty($foreignRecord)) {
array_push($entity->$foreignTableName, $foreignRecord);
}
}
}
}

$this->_trigger('beforeSave', $subject);

if (call_user_func([$this->_table(), $this->saveMethod()], $entity, $this->saveOptions())) {
return $this->_success($subject);
}

$this->_error($subject);
}

/**
* HTTP POST handler
*
* @return \Cake\Http\Response|null
*/
protected function _post()
{
$request = $this->_request();
$subject = $this->_subject();
$id = $request->getParam('id');
$foreignTableName = $request->getParam('foreignTableName');
$data = $request->getData();
$requestMethod = $request->getMethod();

$this->_crud('Crud.Crud')->on('beforeFind', function (\Cake\Event\Event $event) use ($data, $foreignTableName, $requestMethod) {
$query = $event->getSubject()->query;
$query->contain(['Dishes']);
});

$entity = $this->_table()->patchEntity(
$this->_findRecord($id, $subject),
[],
$this->saveOptions()
);

// ensure that only adds new relationships, doesn't destroy old ones
$entity->$foreignTableName = empty($entity->$foreignTableName) ? [] : $entity->$foreignTableName;

$ids = Hash::extract($entity->$foreignTableName, '{n}.id');
$foreignTable = $this->getTableLocator()->get(Inflector::camelize($foreignTableName));
$foreignKey = $foreignTableName . '.id';
foreach ($data as $key => $recordAttributes) {
// get the related record
$query = $foreignTable->findAllById($recordAttributes['id']);
$foreignRecord = $query->first();
// push it onto the relationsships array
if (!empty($foreignRecord)) {
if (in_array($foreignRecord->id, $ids)) {
// don't add id's that are already added
} else {
array_push($entity->$foreignTableName, $foreignRecord);
}
}
}

$this->_trigger('beforeSave', $subject);

if (call_user_func([$this->_table(), $this->saveMethod()], $entity, $this->saveOptions())) {
return $this->_success($subject);
}

$this->_error($subject);
}

/**
* HTTP PATCH handler
*
* @return \Cake\Http\Response|null
*/
protected function _patch()
{
$subject = $this->_subject();
$request = $this->_request();
$id = $request->getParam('id');
$foreignTableName = $request->getParam('foreignTableName');
$data = $request->getData();

$subject->set(['id' => $id]);
$entity = $this->_table()->patchEntity(
$this->_findRecord($id, $subject),
[],
$this->saveOptions()
);
if (empty((array)$data)) {
$entity->$foreignTableName = [];
} else {
$entity->$foreignTableName = [];

$foreignTable = $this->getTableLocator()->get(Inflector::camelize($foreignTableName));
$foreignKey = $foreignTableName . '.id';
foreach ($data as $key => $recordAttributes) {
// get the related record
$query = $foreignTable->findAllById($recordAttributes['id']);
$foreignRecord = $query->first();
// push it onto the relationsships array if it exists
if (!empty($foreignRecord)) {
array_push($entity->$foreignTableName, $foreignRecord);
}
}
}

$this->_trigger('beforeSave', $subject);

if (call_user_func([$this->_table(), $this->saveMethod()], $entity, $this->saveOptions())) {
return $this->_success($subject);
}

$this->_error($subject);
}

/**
* Success callback
*
* @param \Crud\Event\Subject $subject Event subject
* @return \Cake\Http\Response|null
*/
protected function _success(Subject $subject): ?Response
{
$subject->set(['success' => true, 'created' => false]);

$this->setFlash('success', $subject);

return $this->_redirect($subject, ['action' => 'index']);
}

/**
* Error callback
*
* @param \Crud\Event\Subject $subject Event subject
* @return void
*/
protected function _error(Subject $subject): void
{
$subject->set(['success' => false, 'created' => false]);
$this->_trigger('afterSave', $subject);

$this->setFlash('error', $subject);

$this->_trigger('beforeRender', $subject);
}
}
Loading