helpers.php

<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}
<?php

useIlluminate\Support\Facades\Auth;
useLaravel\Horizon\Repositories\RedisJobRepository;
useProcessMaker\Events\MarkArtisanCachesAsInvalid;
useProcessMaker\Models\FormalExpression;
useProcessMaker\Models\Setting;
useProcessMaker\SanitizeHelper;
useProcessMaker\Support\JsonOptimizer;

if (!function_exists('job_pending')) {
/**
 * Check if a given job (by instance or class) is already pending in the queue.
 *
 * @param $job
 *
 * @return bool
 */
functionjob_pending($job): bool
 {
if (is_object($job)) {
$job = class_basename($job);
 }

$queue = app(RedisJobRepository::class)->getRecent();

return$queue->filter(
function ($queued) use ($job) {
return$queued->name === $job
 && ('delayed' === $queued->status
 || 'pending' === $queued->status);
 }
 )->isNotEmpty();
 }
}

if (!function_exists('settings')) {
/**
 * Forwards call to the config() helper.
 *
 * TODO Remove this helper function as it exists now only for backwards compatability
 *
 * @param $key
 *
 * @throws Psr\Container\ContainerExceptionInterface
 * @throws Psr\Container\NotFoundExceptionInterface
 *
 * @return array|mixed
 */
functionsettings($key = null)
 {
return$key ? config()->get($key) : config()->all();
 }
}

if (!function_exists('default_color')) {
/**
 * Returns the default color value.
 *
 * @param $key
 *
 * @return string
 */
functiondefault_color($key)
 {
returnconfig('app.default_colors.' . $key);
 }
}

if (!function_exists('color')) {
/**
 * Returns the color value from the settings.
 *
 * @param $key
 *
 * @return string
 */
functioncolor($key)
 {
if ($setting = Setting::byKey('css-override')) {
$colors = json_decode($setting->config['variables']);
foreach ($colorsas$color) {
if ($color->id === '$' . $key) {
return$color->value;
 }
 }
 }

returndefault_color($key);
 }
}

if (!function_exists('color_rgb')) {
/**
 * Returns the comma-separated RGB values for a theme color.
 *
 * @param string $key
 *
 * @return string
 */
functioncolor_rgb($key)
 {
$hex = ltrim(color($key), '#');

if (strlen($hex) === 3) {
$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
 }

if (strlen($hex) !== 6 || !ctype_xdigit($hex)) {
return'39, 115, 243';
 }

returnhexdec(substr($hex, 0, 2))
 . ', ' . hexdec(substr($hex, 2, 2))
 . ', ' . hexdec(substr($hex, 4, 2));
 }
}

if (!function_exists('sidebar_class')) {
/**
 * Returns the class for the sidebar based on admin settings.
 *
 * @return bool
 */
functionsidebar_class()
 {
if (Setting::byKey('css-override')) {
$defaults = ['#0872C2', '#2773F3'];
if (!in_array(color('primary'), $defaults)) {
return'sidebar-custom';
 }
 }

return'sidebar-default';
 }
}

if (!function_exists('refresh_artisan_caches')) {
/**
 * Re-caches artisan config, routes, and/or events when they are already cached.
 */
functionrefresh_artisan_caches(): void
 {
 MarkArtisanCachesAsInvalid::dispatch();
 }
}

if (!function_exists('lavaryMenuArray')) {
/**
 * Convert the Laravy menu into associative array.
 *
 * @param Lavary\Menu\Item $menu
 * @param mixed $includeSubMenus
 *
 * @return array
 */
functionlavaryMenuArray($menu, $includeSubMenus = false)
 {
$children = [];
$subMenus = $includeSubMenus ? $menu->children() : null;

if ($subMenus) {
foreach ($subMenusas$child) {
$children[] = lavaryMenuArray($child);
 }
 }

return [
'title' => __($menu->title),
'id' => $menu->id,
'attributes' => $menu->attributes,
'url' => $menu->url(),
'children' => $children,
 ];
 }
}

if (!function_exists('lavaryMenuJson')) {
/**
 * Convert the Laravy menu into json string.
 *
 * @param Lavary\Menu\Item $menu
 *
 * @return false|string
 */
functionlavaryMenuJson($menu)
 {
returnjson_encode(lavaryMenuArray($menu, true));
 }
}

if (!function_exists('hasPackage')) {
/**
 * Check if a package exists based on its provider name.
 *
 * @param $name
 *
 * @throws Illuminate\Contracts\Container\BindingResolutionException
 *
 * @return bool
 */
functionhasPackage($name)
 {
$list = app()->make(ProcessMaker\Managers\PackageManager::class)->listPackages();

returnin_array($name, $list);
 }
}

if (!function_exists('pmUser')) {
/**
 * Check both the web and api middleware for an existing user.
 *
 * @return null|ProcessMaker\Models\User
 */
functionpmUser()
 {
if (Auth::user()) {
return Auth::user();
 }

if (Auth::guard('api')->user()) {
return Auth::guard('api')->user();
 }

returnnull;
 }
}

if (!function_exists('sanitizeVueExp')) {
/**
 * @param $expression
 *
 * @return array|string|string[]
 */
functionsanitizeVueExp($expression)
 {
return SanitizeHelper::sanitizeVueExp($expression);
 }
}

if (!function_exists('packTemporalData')) {
/**
 * Store data into store/app/private.
 *
 * @param $data
 *
 * @return string
 */
functionpackTemporalData($data)
 {
$uid = uniqid('data_', true);
$path = storage_path('app/private/' . $uid);

file_put_contents($path, json_encode($data));

return$uid;
 }
}

if (!function_exists('unpackTemporalData')) {
/**
 * @param $uid
 *
 * @return array|mixed
 */
functionunpackTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
returnjson_decode(file_get_contents($path), true);
 }

return [];
 }
}

if (!function_exists('removeTemporalData')) {
/**
 * @param $uid
 */
functionremoveTemporalData($uid)
 {
$path = storage_path('app/private/' . $uid);

if (file_exists($path)) {
 @unlink($path);
 }
 }
}

if (!function_exists('shouldShow')) {
/**
 * @param string $element
 *
 * @return bool
 */
functionshouldShow($element)
 {
if (Session::has('visibilitySettings')) {
return Session::get('visibilitySettings')->{$element} ?? true;
 } else {
returntrue;
 }
 }
}

if (!function_exists('calculateProgressById')) {
/**
 * Calculates the progress percentage of a stage based on its order
 * within the total number of stages.
 *
 * This function searches for the stage with the given ID in the provided list
 * of stages. Each stage must contain at least 'id' and 'order' keys.
 * If the stage is found, it calculates the progress as:
 * (stage_order / total_stages) * 100
 *
 * The result is rounded to two decimal places.
 *
 * If the list of stages is `null` or empty, or if the stage with the given ID
 * is not found, the function returns 0.0.
 *
 * @param int|null $id The ID of the stage to calculate progress for.
 * @param array|null $stages An array of stages, where each stage is an associative array
 * containing at least the keys 'id' and 'order'.
 * This parameter can be null.
 *
 * @return float The progress percentage (0.0 to 100.0), rounded to two decimal places.
 */
functioncalculateProgressById(int|null$id, array|null$stages = [])
 {
if (empty($stages)) {
return0.0;
 }
$totalStages = count($stages);
// Consider the completed stage as the last one
$totalStages++;
$currentStageOrder = 0;
foreach ($stagesas$stage) {
if ($stage['id'] === $id) {
$currentStageOrder = $stage['order'];
break;
 }
 }
if ($currentStageOrder === 0) {
return0.0;
 }
$progress = ($currentStageOrder / $totalStages) * 100;

returnround($progress, 2);
 }
}

if (!function_exists('validateURL')) {
/**
 * Validate the URL
 *
 * @return Closure
 */
functionvalidateURL(): Closure
 {
returnfunction ($attribute, $value, $fail) {
if (!empty($value)) {
$pattern = '/^(https:\/\/|http:\/\/)(\*\.)?([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(:\d+)?$/';
if (!preg_match($pattern, $value)) {
$fail('The URL format is invalid. It must start with http:// or https:// and be a valid domain.');
 }
 }
 };
 }
}

if (!function_exists('json_optimize_decode')) {
/**
 * Decodes a JSON using simdjson if available.
 *
 * @param string $json
 * @param bool $assoc
 * @param int $depth
 * @param int $options
 * @return mixed
 */
functionjson_optimize_decode(string$json, bool$assoc = false, int$depth = 512, int$options = 0)
 {
return JsonOptimizer::decode($json, $assoc, $depth, $options);
 }
}

if (!function_exists('feelExpression')) {
/**
 * Evaluate a BPMN FEEL expression
 *
 * @param string $expression
 * @param array $data
 * @return mixed
 */
functionfeelExpression(string$expression, array$data)
 {
$formalExp = newFormalExpression();
$formalExp->setLanguage('FEEL');
$formalExp->setBody($expression);

return$formalExp($data);
 }
}