Skip to content

abstract the only parameter #4991

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
merged 3 commits into from
Sep 10, 2024
Merged

abstract the only parameter #4991

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0edb00c
abstract the only parameter
Mh-Asmi Sep 3, 2024
7c60d3d
fix test
Mh-Asmi Sep 3, 2024
f3d8e16
Merge branch 'develop' into USH-1387
Mh-Asmi Sep 10, 2024
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
155 changes: 155 additions & 0 deletions src/Ushahidi/Modules/V5/Actions/Post/HandlePostOnlyParameters.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
<?php

namespace Ushahidi\Modules\V5\Actions\Post;

use Ushahidi\Modules\V5\Models\Post\Post;
use Ushahidi\Contracts\Sources;
use Ushahidi\Modules\V5\Http\Resources\LockCollection;
use Ushahidi\Modules\V5\Models\Contact;
use Illuminate\Support\Collection;
use Ushahidi\Modules\V5\Http\Resources\PostValueCollection;

trait HandlePostOnlyParameters
{
public function addHydrateRelationships(Post $post, array $hydrates)
{
foreach ($hydrates as $hydrate) {
switch ($hydrate) {
case 'color':
$post->color = $post->survey ? $post->survey->color : null;
break;
case 'categories':
// $result['categories'] = $post->categories;
break;
case 'completed_stages':
$post->completed_stages = $post->postStages;

break;
case 'post_content':
$post->post_content = $this->getResourcePostContent($post);
break;
case 'translations':
break;
case 'contact':
$post->contact = null;
if ($post->source === Sources::WHATSAPP) {
if ($this->userHasManagePostPermissions()) {
if (isset($post->metadata['contact'])) {
$post->contact = (new Contact)->fill($post->metadata['contact']);
}
} else {
if (isset($post->metadata['contact']['id'])) {
$post->contact = (new Contact)->fill(['id'=>$post->metadata['contact']['id']]);
}
}
}
if ($post->message) {
if ($this->userHasManagePostPermissions()) {
$post->contact = $post->message->contact;
} else {
$post->contact = $post->message->contact->setVisible(["id"]);
}
}
break;
case 'locks':
$post->locks = new LockCollection($post->locks);
break;

case 'source':
$message = $post->message;
$post->source = $post->source ?? ($message && isset($message->type)
? $message->type
: Post::DEFAULT_SOURCE_TYPE);

break;

case 'data_source_message_id':
$post->data_source_message_id = null;
$message = $post->message;
if ($message) {
$post->data_source_message_id = $message->data_source_message_id ?? null;
}
break;
case 'message':
if ($post->message && !$this->userHasManagePostPermissions()) {
$post->message->makeHidden("contact");
}
break;
case 'enabled_languages':
$post->enabled_languages = [
'default' => $post->base_language,
'available' => $post->translations->groupBy('language')->keys()
];
$relations['enabled_languages'] = true;
break;
}
}
return $post;
}
public function hideFieldsUsedByRelationships(Post $post, array $fields = [])
{
foreach ($fields as $field) {
$post->offsetUnset($field);
}
$post->offsetUnset('values_int');

return $post;
}
public function hideUnwantedRelationships(Post $post, array $hydrates)
{
// hide post_content relationships
$post->makeHidden('survey');
$post->makeHidden('valuesVarchar');
$post->makeHidden('valuesInt');
$post->makeHidden('valuesText');
$post->makeHidden('valuesDatetime');
$post->makeHidden('valuesDecimal');
$post->makeHidden('valuesDecimal');
$post->makeHidden('valuesGeometry');
$post->makeHidden('valuesMarkdown');
$post->makeHidden('valuesMedia');
$post->makeHidden('valuesPoint');
$post->makeHidden('valuesRelation');
$post->makeHidden('valuesPostsMedia');
$post->makeHidden('valuesPostsSet');
$post->makeHidden('valuesPostTag');

// hide source relationships
if (!in_array('message', $hydrates)) {
$post->makeHidden('message');
}

// hide completed_stages relationships
$post->makeHidden('postStages');


return $post;
}

private function getResourcePostContent($post)
{
$values = $post->getPostValues(); // Calling method on Post Model
$no_values = $values->count() === 0 ? true : false;
$col = new Collection([
'values' => $values,
'tasks' => $post->survey ? $post->survey->tasks : []
]);
if ($post->survey) {
$post_content = new PostValueCollection($col);
} else {
$post_content = Collection::make([]);
}
return $post_content;
}

public function handleSourceField($post)
{
if (!$post->source) {
$message = $post->message;
$post->source = ($message && isset($message->type)
? $message->type
: Post::DEFAULT_SOURCE_TYPE);
}
return $post;
}
}
146 changes: 3 additions & 143 deletions src/Ushahidi/Modules/V5/Actions/Post/Handlers/FindPostByIdQueryHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,11 @@
use Ushahidi\Modules\V5\Actions\Post\Handlers\AbstractPostQueryHandler;
use Ushahidi\Modules\V5\Actions\Post\Queries\FindPostByIdQuery;
use Ushahidi\Modules\V5\Repository\Post\PostRepository;
use Ushahidi\Modules\V5\Models\Post\Post;
use Ushahidi\Modules\V5\Models\Contact;
use Illuminate\Support\Collection;
use Ushahidi\Modules\V5\Http\Resources\PostValueCollection;
use Ushahidi\Modules\V5\Http\Resources\ContactPointerResource;
use Ushahidi\Modules\V5\Http\Resources\MessagePointerResource;
use Ushahidi\Modules\V5\Http\Resources\LockCollection;
use Ushahidi\Modules\V5\Http\Resources\Survey\TaskCollection;
use Ushahidi\Contracts\Sources;
use Ushahidi\Modules\V5\Actions\Post\HandlePostOnlyParameters;

class FindPostByIdQueryHandler extends AbstractPostQueryHandler
{
use HandlePostOnlyParameters;
private $postRepository;

public function __construct(PostRepository $postRepository)
Expand Down Expand Up @@ -52,140 +45,7 @@ public function __invoke(Action $action)
$post,
array_diff($action->getFieldsForRelationship(), $action->getFields())
);
$post = $this->handleSourceField($post);
return $this->hideUnwantedRelationships($post, $action->getHydrates());
}

private function addHydrateRelationships(Post $post, array $hydrates)
{
foreach ($hydrates as $hydrate) {
switch ($hydrate) {
case 'color':
$post->color = $post->survey ? $post->survey->color : null;
break;
case 'categories':
// $result['categories'] = $post->categories;
break;
case 'sets':
// $post->sets = $post->sets->pluck('id');
break;
case 'completed_stages':
$post->completed_stages = $post->postStages;

break;
case 'post_content':
$post->post_content = $this->getResourcePostContent($post);
break;
case 'translations':
break;
case 'contact':
$post->contact = null;
if ($post->source === Sources::WHATSAPP) {
if ($this->userHasManagePostPermissions()) {
if (isset($post->metadata['contact'])) {
// $post->contact = Contact::find($post->contact_id); // not good in case there are many whatsapp posts this will be problem for the DB
$post->contact = (new Contact)->fill($post->metadata['contact']);
}
} else {
if (isset($post->metadata['contact']['id'])) {
$post->contact = (new Contact)->fill(['id'=>$post->metadata['contact']['id']]);
}
}
} elseif ($post->message) {
if ($this->userHasManagePostPermissions()) {
$post->contact = $post->message->contact;
} else {
$post->contact = $post->message->contact->setVisible(["id"]);
}
}
break;
case 'locks':
$post->locks = new LockCollection($post->locks);
break;

case 'source':
$message = $post->message;
$post->source = $post->source ?? ($message && isset($message->type)
? $message->type
: Post::DEFAULT_SOURCE_TYPE);

break;

case 'data_source_message_id':
$post->data_source_message_id = null;
$message = $post->message;
if ($message) {
$post->data_source_message_id = $message->data_source_message_id ?? null;
}
break;
case 'message':
if ($post->message && !$this->userHasManagePostPermissions()) {
$post->message->makeHidden("contact");
}
break;
case 'enabled_languages':
$post->enabled_languages = [
'default' => $post->base_language,
'available' => $post->translations->groupBy('language')->keys()
];
$relations['enabled_languages'] = true;
break;
}
}
return $post;
}
private function hideFieldsUsedByRelationships(Post $post, array $fields = [])
{
foreach ($fields as $field) {
$post->offsetUnset($field);
}
$post->offsetUnset('values_int');

return $post;
}
private function hideUnwantedRelationships(Post $post, array $hydrates)
{
// hide post_content relationships
$post->makeHidden('survey');
$post->makeHidden('valuesVarchar');
$post->makeHidden('valuesInt');
$post->makeHidden('valuesText');
$post->makeHidden('valuesDatetime');
$post->makeHidden('valuesDecimal');
$post->makeHidden('valuesDecimal');
$post->makeHidden('valuesGeometry');
$post->makeHidden('valuesMarkdown');
$post->makeHidden('valuesMedia');
$post->makeHidden('valuesPoint');
$post->makeHidden('valuesRelation');
$post->makeHidden('valuesPostsMedia');
$post->makeHidden('valuesPostsSet');
$post->makeHidden('valuesPostTag');

// hide source relationships
if (!in_array('message', $hydrates)) {
$post->makeHidden('message');
}

// hide completed_stages relationships
$post->makeHidden('postStages');


return $post;
}

private function getResourcePostContent($post)
{
$values = $post->getPostValues(); // Calling method on Post Model
$no_values = $values->count() === 0 ? true : false;
$col = new Collection([
'values' => $values,
'tasks' => $post->survey ? $post->survey->tasks : []
]);
if ($post->survey) {
$post_content = new PostValueCollection($col);
} else {
$post_content = Collection::make([]);
}
return $post_content;
}
}
Loading
Loading