Jaxon

Data bags are data sets that are stored on client side, and made available on demand in Jaxon classes. They are convenient for data that must be available allover the application, but are only used by a few components.

Each data bag has an identifier which must be unique throughout the application, and each of its data is stored under a key which must be unique throughout the data bag.

To be able to read data from a data bag in a method of a Jaxon class, it must explicitly requested that its content is sent in requests to this method.

This is done either with annotations in the class, or when registering the class in the configuration file, or with calls to the Jaxon object.

Note on security

Since the data in data bags are stored in the browser, they are accessible to users. Therefore, sensitive data should not be stored in them. Likewise, they should store as little data as possible, as this increases the size of Jaxon requests.

Annotation

The @databag annotation is defined on a class or method to configure data bags. It takes its unique identifier as a parameter, and can be repeated to define multiple data bags.

If the annotation is defined on a Jaxon class, then all its methods will receive the contents of the data bag.

namespace Ns\App;

/**
 * @databag bag_key
 */
class FirstClass extends \Jaxon\App\FuncComponent
{
    public function doThat()
    {
        $bagValue = $this->bag('bag_key')->get('value_key');
        // ...
    }
}

If the annotation is defined on a method, then only that method will receive the contents of the data bag.

namespace Ns\App;

class SecondClass extends \Jaxon\App\FuncComponent
{
    /**
     * @databag bag_key
     */
    public function doThat()
    {
        $bagValue = $this->bag('bag_key')->get('value_key');
        // ...
    }
}

Configuration

With the configurations below, the data bag bag_key will be passed in requests to all methods of the \Ns\App\FirstClass class, and in requests to the doThat() method of the \Ns\App\SecondClass class.

$jaxon->register(Jaxon::CALLABLE_DIR, '/the/class/dir', [
    'namespace' => 'Ns',
    'classes' => [
        \Ns\App\FirstClass::class => [
            'functions' => [
                '*' => [
                    'bags' => ["'bag_key'"]
                ]
            ]
        ],
        \Ns\App\SecondClass::class => [
            'functions' => [
                'doThat' => [
                    'bags' => ["'bag_key'"]
                ]
            ]
        ]
    ]
]);

    'app' => [
        'directories' => [
            '/the/class/dir' => [
                'namespace' => 'Ns',
                // 'autoload' => true,
                // 'separator' => '.',
                // 'protected' => [],
                'classes' => [
                    \Ns\App\FirstClass::class => [
                        'functions' => [
                            '*' => [
                                'bags' => ["'bag_key'"]
                            ]
                        ]
                    ],
                    \Ns\App\SecondClass::class => [
                        'functions' => [
                            'doThat' => [
                                'bags' => ["'bag_key'"]
                            ]
                        ]
                    ]
                ]
            ]
        ]
    ]

namespace Ns\App;

class SecondClass extends \Jaxon\App\FuncComponent
{
    public function doThat()
    {
        $bagValue = $this->bag('bag_key')->get('value_key');
        // ...
    }
}

Access to data bags

All Jaxon component classes have a bag() function that takes an identifier as a parameter and returns the corresponding data bag object. The data bag object has two functions set() and get() which allow to respectively set or read a value in the data bag.

/**
 * @databag bag_key
 */
class FirstClass extends \Jaxon\App\FuncComponent
{
    public function save()
    {
        // The value is saved in the browser.
        $this->bag('bag_key')->set('value_key', $value);
    }

    public function read()
    {
        // The value is sent from the browser to the application.
        $value = $this->bag('bag_key')->get('value_key');
    }
}