README

A Symfony bundle to integrate Sencha Ext JS into a Symfony application

Installation

You can install this bundle using composer

composer require teqneers/ext-application-bundle

or add the package to your composer.json file directly.

After you have installed the package, you just need to add the bundle to your AppKernel.php file:

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new TQ\Bundle\ExtJSApplicationBundle\TQExtJSApplicationBundle(),
    // ...
);

Configuration

The ext-application-bundle requires some initial configuration so that it can find the correct files.

# Default configuration for extension with alias: "tq_ext_js_application"
tq_ext_js_application:
    app_path:             ~ # Required
    builds:               # Required
        # Prototype
        name:
            development:          # Required
                build_path:           ~ # Required
                microloader:          /bootstrap.js
                manifest:             /bootstrap.json
                app_cache:            null
            production:           # Required
                build_path:           ~ # Required
                microloader:          microloader.js
                manifest:             app.json
                app_cache:            cache.appcache

Because the bundle provides its own controller to serve micro-loader, manifest and application cache manifest, you also need to configure your routing to include the bundle routes at a given prefix. Edit your app/config/routing.yml:

# ...
ext_app:
    resource: "@TQExtJSApplicationBundle/Resources/config/routing.yml"
    prefix:/
# ...

Example

Given the following directory structure of a fictitious Symfony application

./
|-- app/            Application configuration and assets
|-- src/            Application source code
|-- web/            Public web-facing directory (document root)
|   |-- app.php     Symfony production front controller
|   |-- app_dev.php Symfony development front controller
|   |-- app/        Root folder for Ext JS application production build
|-- ExampleApp/     The Ext JS application source folder

your configuration might look like this

tq_ext_js_application:
    app_path: '%kernel.project_dir%/ExampleApp'
    builds:
        default:
            development:
                build_path:  build/development/ExampleApp
                microloader: /bootstrap.js
                manifest:    /bootstrap.json
                app_cache:   ~
            production:
                build_path:  build/production/ExampleApp
                microloader: microloader.js
                manifest:    app.json
                app_cache:   cache.appcache

Usage

Using the Twig extension provided by the bundle you can easily integrate the Ext JS application resources into your application templates.

<!DOCTYPE HTML>
<html manifest="{{ extjsAppCachePath() }}" lang="en">
<head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta charset="UTF-8">
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <title>Welcome!</title>

    <script type="text/javascript">
        var Ext = Ext || {};
        Ext.manifest = '{{ extjsManifestPath()|e('js') }}';
    </script>
    <script id="microloader" data-app="{{ extjsApplicationId() }}" type="text/javascript" src="{{ extjsBootstrapPath() }}"></script>
</head>
<body>
</body>
</html>

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

teqneers / ext-application-bundle

Maintainers

Details