App Params¶
App params are returned by the back-end once a user logged in. You can use these params in the front-end. For example, Espo has a build-in app-param containing a list of entity types that can be printed to PDF for a current user.
Custom app params¶
You can make the system to return custom parameters. This params can be unique for a current user (different user have different values in params).
Create a file: custom/Espo/Custom/Resources/metadata/app/appParams.json
:
{
"myParam": {
"className": "Espo\\Custom\\Core\\AppParams\\MyParam"
}
}
Create a file custom/Espo/Custom/Core/AppParams/MyParam.php
:
<?php
namespace Espo\Custom\Core\AppParams;
use Espo\Tools\App\AppParam;
class MyParam implements AppParam
{
public function __construct(
// Pass needed dependencies.
) {}
public function get(): mixed
{
// Value fetching logic.
// Your value can be a scalar, array or stdClass.
return $someValue;
}
Clear cache.
In the front-end (in a View) you can access your parameter the following way:
this.getHelper().getAppParam('myParam');