FOUR-15872 Implement task screen endpoint#6913

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
caleeli merged 8 commits into from
Jun 6, 2024
Merged

FOUR-15872 Implement task screen endpoint #6913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
556452c
Merge pull request #6897 from ProcessMaker/FOUR-15868
caleeli May 31, 2024
bc0d2d3
Add task screen endpoint
caleeli Jun 4, 2024
d2b24aa
Register endpoint
caleeli Jun 4, 2024
07c44e0
Add test for task screen endpoint
caleeli Jun 5, 2024
4d7ec3f
Reduce the size of response
caleeli Jun 6, 2024
46add45
Move resource screen functions into a trait
caleeli Jun 6, 2024
1ad9ba7
Update test
caleeli Jun 6, 2024
0eb08d8
Clean code
caleeli Jun 6, 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
15 changes: 15 additions & 0 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
{
return $task;
}

public function showScreen($taskId)
{
$task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
->findOrFail($taskId);
$response = new TaskScreen($task);
$response = response($response->toArray(request())['screen'], 200);
$now = time();
// screen cache time
$cacheTime = config('screen_task_cache_time', 86400);
$response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
$response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
return $response;
}
}
59 changes: 59 additions & 0 deletions ProcessMaker/Http/Resources/V1_1/TaskScreen.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
use TaskScreenResourceTrait;

/**
* Transform the resource into an array.
*
* @param \Illuminate\Http\Request
* @return array
*/
public function toArray($request)
{
return $this->includeScreen($request);
}

private function includeScreen($request)
{
$array = ['screen' => null];

$screen = $this->getScreenVersion();

if ($screen) {
if ($screen->type === 'ADVANCED') {
$array['screen'] = $screen;
} else {
$resource = new ScreenVersionResource($screen);
$array['screen'] = $resource->toArray($request);
}
} else {
$array['screen'] = null;
}

if ($array['screen']) {
// Apply translations to screen
$processTranslation = new ProcessTranslation($this->process);
$array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
$array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

// Apply translations to nested screens
if (array_key_exists('nested', $array['screen'])) {
foreach ($array['screen']['nested'] as &$nestedScreen) {
$nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
$nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
}
}
}

return $array;
}
}
11 changes: 10 additions & 1 deletion ProcessMaker/Traits/TaskResourceIncludes.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
use TaskScreenResourceTrait;

private function includeData()
{
return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

private function includeProcessRequest()
{
return ['process_request' => new Users($this->processRequest)];
return ['process_request' => $this->processRequest->attributesToArray()];
}

private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
// Apply translations to screen
$processTranslation = new ProcessTranslation($this->process);
$array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
$array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

// Apply translations to nested screens
if (array_key_exists('nested', $array['screen'])) {
foreach ($array['screen']['nested'] as &$nestedScreen) {
$nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
$nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
}
}
}
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
$translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
$interstitial['interstitial_screen']['config'] = $translatedConf;

// Remove inspector metadata
$interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
$interstitial['interstitial_screen']['config']
);

return [
'allow_interstitial' => $interstitial['allow_interstitial'],
'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down
45 changes: 45 additions & 0 deletions ProcessMaker/Traits/TaskScreenResourceTrait.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

/**
* Removes the inspector metadata from the screen configuration
*
* @param array $config
* @return array
*/
private function removeInspectorMetadata(array $config)
{
foreach ($config as $i => $page) {
$config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
}
return $config;
}

/**
* Removes the inspector metadata from the screen configuration items
*
* @param array $items
* @return array
*/
private function removeInspectorMetadataItems(array $items)
{
foreach ($items as $i => $item) {
if (isset($item['inspector'])) {
unset($item['inspector']);
}
if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
foreach ($item['items'] as $c => $col) {
$item['items'][$c] = $this->removeInspectorMetadataItems($col);
}
} elseif (isset($item['items']) && is_array($item['items'])) {
$item['items'] = $this->removeInspectorMetadataItems($item['items']);
}
$items[$i] = $item;
}
return $items;
}
}
13 changes: 9 additions & 4 deletions routes/v1_1/api.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
->name('api.1.1.')
->group(function () {
// Tasks Endpoints
Route::name('tasks.')->group(function () {
Route::name('tasks.')->prefix('tasks')->group(function () {
// Route to list tasks
Route::get('tasks', [TaskController::class, 'index'])
Route::get('/', [TaskController::class, 'index'])
->name('index');

// Route to show a task
Route::get('tasks/{task}', [TaskController::class, 'show'])
->name('show');
Route::get('/{task}', [TaskController::class, 'show'])
->name('show')
->middleware(['bindings','can:view,task']);

// Route to show the screen of a task
Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
->name('show.screen');
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
FOUR-15872 Implement task screen endpoint#6913

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

caleeli
merged 8 commits into

from

Jun 6, 2024
 Merged


FOUR-15872 Implement task screen endpoint
#6913
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
556452c

Merge pull request #6897 from ProcessMaker/FOUR-15868


caleeli May 31, 2024
bc0d2d3

Add task screen endpoint


caleeli Jun 4, 2024
d2b24aa

Register endpoint


caleeli Jun 4, 2024
07c44e0

Add test for task screen endpoint


caleeli Jun 5, 2024
4d7ec3f

Reduce the size of response


caleeli Jun 6, 2024
46add45

Move resource screen functions into a trait


caleeli Jun 6, 2024
1ad9ba7

Update test


caleeli Jun 6, 2024
0eb08d8

Clean code


caleeli Jun 6, 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


15 changes: 15 additions & 0 deletions
ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Models\ProcessRequestToken;
use ProcessMaker\Http\Resources\V1_1\TaskScreen;

class TaskController extends Controller
{
Expand All@@ -30,4 +31,18 @@ public function show(ProcessRequestToken $task)
 {
 return $task;
 }

 public function showScreen($taskId)
 {
 $task = ProcessRequestToken::select('id', 'process_request_id', 'element_id', 'process_id')
 ->findOrFail($taskId);
 $response = new TaskScreen($task);
 $response = response($response->toArray(request())['screen'], 200);
 $now = time();
 // screen cache time
 $cacheTime = config('screen_task_cache_time', 86400);
 $response->headers->set('Cache-Control', 'max-age=' . $cacheTime . ', must-revalidate, public');
 $response->headers->set('Expires', gmdate('D, d M Y H:i:s', $now + $cacheTime) . ' GMT');
 return $response;
 }
}

59 changes: 59 additions & 0 deletions
ProcessMaker/Http/Resources/V1_1/TaskScreen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
<?php

namespace ProcessMaker\Http\Resources\V1_1;

use ProcessMaker\Http\Resources\ApiResource;
use ProcessMaker\Http\Resources\ScreenVersion as ScreenVersionResource;
use ProcessMaker\ProcessTranslations\ProcessTranslation;
use ProcessMaker\Traits\TaskScreenResourceTrait;

class TaskScreen extends ApiResource
{
 use TaskScreenResourceTrait;

 /**
 * Transform the resource into an array.
 *
 * @param \Illuminate\Http\Request
 * @return array
 */
 public function toArray($request)
 {
 return $this->includeScreen($request);
 }

 private function includeScreen($request)
 {
 $array = ['screen' => null];

 $screen = $this->getScreenVersion();

 if ($screen) {
 if ($screen->type === 'ADVANCED') {
 $array['screen'] = $screen;
 } else {
 $resource = new ScreenVersionResource($screen);
 $array['screen'] = $resource->toArray($request);
 }
 } else {
 $array['screen'] = null;
 }

 if ($array['screen']) {
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }

 return $array;
 }
}

11 changes: 10 additions & 1 deletion
ProcessMaker/Traits/TaskResourceIncludes.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,8 @@

trait TaskResourceIncludes
{
 use TaskScreenResourceTrait;

 private function includeData()
 {
 return ['data' => $this->getData()];
Expand All@@ -29,7 +31,7 @@ private function includeRequestor()

 private function includeProcessRequest()
 {
 return ['process_request' => new Users($this->processRequest)];
 return ['process_request' => $this->processRequest->attributesToArray()];
 }

 private function includeDraft()
Expand DownExpand Up@@ -72,11 +74,13 @@ private function includeScreen($request)
 // Apply translations to screen
 $processTranslation = new ProcessTranslation($this->process);
 $array['screen']['config'] = $processTranslation->applyTranslations($array['screen']);
 $array['screen']['config'] = $this->removeInspectorMetadata($array['screen']['config']);

 // Apply translations to nested screens
 if (array_key_exists('nested', $array['screen'])) {
 foreach ($array['screen']['nested'] as &$nestedScreen) {
 $nestedScreen['config'] = $processTranslation->applyTranslations($nestedScreen);
 $nestedScreen['config'] = $this->removeInspectorMetadata($nestedScreen['config']);
 }
 }
 }
Expand DownExpand Up@@ -125,6 +129,11 @@ private function includeInterstitial()
 $translatedConf = $processTranslation->applyTranslations($interstitial['interstitial_screen']);
 $interstitial['interstitial_screen']['config'] = $translatedConf;

 // Remove inspector metadata
 $interstitial['interstitial_screen']['config'] = $this->removeInspectorMetadata(
 $interstitial['interstitial_screen']['config']
 );

 return [
 'allow_interstitial' => $interstitial['allow_interstitial'],
 'interstitial_screen' => $interstitial['interstitial_screen'],
Expand Down

45 changes: 45 additions & 0 deletions
ProcessMaker/Traits/TaskScreenResourceTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Traits;

trait TaskScreenResourceTrait
{

 /**
 * Removes the inspector metadata from the screen configuration
 *
 * @param array $config
 * @return array
 */
 private function removeInspectorMetadata(array $config)
 {
 foreach ($config as $i => $page) {
 $config[$i]['items'] = $this->removeInspectorMetadataItems($page['items']);
 }
 return $config;
 }

 /**
 * Removes the inspector metadata from the screen configuration items
 *
 * @param array $items
 * @return array
 */
 private function removeInspectorMetadataItems(array $items)
 {
 foreach ($items as $i => $item) {
 if (isset($item['inspector'])) {
 unset($item['inspector']);
 }
 if (isset($item['component']) && $item['component'] === 'FormMultiColumn') {
 foreach ($item['items'] as $c => $col) {
 $item['items'][$c] = $this->removeInspectorMetadataItems($col);
 }
 } elseif (isset($item['items']) && is_array($item['items'])) {
 $item['items'] = $this->removeInspectorMetadataItems($item['items']);
 }
 $items[$i] = $item;
 }
 return $items;
 }
}

13 changes: 9 additions & 4 deletions
routes/v1_1/api.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,13 +8,18 @@
 ->name('api.1.1.')
 ->group(function () {
 // Tasks Endpoints
 Route::name('tasks.')->group(function () {
 Route::name('tasks.')->prefix('tasks')->group(function () {
 // Route to list tasks
 Route::get('tasks', [TaskController::class, 'index'])
 Route::get('/', [TaskController::class, 'index'])
 ->name('index');

 // Route to show a task
 Route::get('tasks/{task}', [TaskController::class, 'show'])
 ->name('show');
 Route::get('/{task}', [TaskController::class, 'show'])
 ->name('show')
 ->middleware(['bindings','can:view,task']);

 // Route to show the screen of a task
 Route::get('/{taskId}/screen', [TaskController::class, 'showScreen'])
 ->name('show.screen');
 });
 });
Loading