zitec/js-data-bundle

This bundle transports pieces of information from PHP to JS.

Maintainers

Details

github.com/zitec/js-data-bundle

Homepage

Source

Issues

Installs: 17

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 1

Open Issues: 0

Type:symfony-bundle

v1.0.0 2020-06-04 15:24 UTC

Requires

Requires (Dev)

MIT 44cc5f0a107075cabbe06dfd62bcc637477a3243

This package is auto-updated.

Last update: 2024-04-04 23:56:36 UTC

README

This bundle transports pieces of information from PHP to JavaScript.

How to use

Inject the Zitec\JSDataBundle\Service\DataHandler service into your controller action and add the data.

<?php

namespace App\Controller;

use Zitec\JSDataBundle\Service\DataHandler;

class SimpleController
{
    public function indexAction(DataHandler $jsDataHandler)
    {
        $jsDataHandler->add('[Colors]', ['Red', 'Green', 'Blue']);

        return $this->render('index.html.twig');
    }
}

Render the data in the template.

<head>
    <head></head>
    <body>
        {{ zitec_js_data_get_all() }}
    </body>
</html>

Bundle components

DataCollectorInterface

Represents an interface which all JS data collectors must implement. A data collector is nothing more than an object whose role is to collect data from different components. At a given point, the collected data will be fetched in a template and assigned to a JS variable. Basically, the data collector transports pieces of information from PHP to JS.

Methods

  • getAll(): Fetches the collected data.
  • add($path, $value): Sets a value at the given path in the data object.
  • merge(array $data): Merges the given data set to the existing set.

DataCollectEvent

Represents an event which is triggered when data is demanded for the first time from the data handler service. Other bundles can listen to it in order to alter the JS data set.

DataHandler

A service which handles the data sent to the client's scripts. Bundles throughout the application may use this service to add their own or alter the information from the JS data set.

Properties

  • dataCollector: the data collector used to collect JS data.
  • eventDispatcher: the event dispatcher service.
  • collected (bool): flag which marks if data was collected from other bundles.

Methods

  • add($path, $value): adds the given value into the data collector.
  • merge(array data): merges the given data set into the collector.
  • getAll(): fetches the collected data.
  • collect(): collects data from other bundles by dispatching the data_collect event. The event is triggered only once.

JSDataExtension:

Twig extension which makes the JS data handler available in the templates through functions which are proxies to its methods.

Properties

  • $dataHandler: the data handler service.

Methods

  • getFunctions()
    • zitec_js_data_add call addFunction;
    • zitec_js_data_merge call mergeFunction;
    • zitec_js_data_get_all call getAllFunction;
  • getName(): return ‘zitec_js_data_extensions’;
  • addFunction($path, $value): call $dataHandler->add($path, $value);
  • mergeFunction(array $data): call $dataHandler->merge($data);
  • getAllFunction($jsonEncodeOptions):
    • $jsonEncodeOptions: default value is 0;
    • The data is outputted directly in the JSON format,so you can assign it to a JS variable.

License

This bundle is covered by the MIT license. See LICENSE for details.