包简介

Jaxon library integration for the Symfony Framework

README 文档

README

This package is an extension to integrate the Jaxon library into the Symfony framework. It works with Symfony version 5 or newer.

Installation

Add the following lines in the composer.json file, and run the composer update jaxon-php/ command.

"require": {
    "jaxon-php/jaxon-symfony": "^5.0"
}

Add the Jaxon bundle in the config/bundle.php file.

return [
    ...

    Jaxon\Symfony\JaxonBundle::class => ['all' => true],
];

Configuration

The library configuration is located in the packages/config/jaxon.yaml file. It must contain both the app and lib sections defined in the documentation (https://www.jaxon-php.org/docs/v5x/about/configuration.html).

An example is presented in the config/jaxon.yaml file of this repo.

Add the following settings in the config/services.yaml file, to configure the Jaxon library.

imports:
    ...
    - { resource: packages/jaxon.yaml }

Add the following settings in the config/routes.yaml file, to configure the Jaxon route.

jaxon_ajax:
    resource: 'Jaxon\Symfony\App\Jaxon::route'
    type: service

Routing and listener

The extension provides a route and a controller to process Jaxon Ajax requests, as well as a listener on the kernel.controller event to bootstrap the Jaxon library.

Dependency injection

Services in Symfony can be declared as public or private, and injected in Jaxon classes.

Since Jaxon uses a container to fetch to the Symfony services that are injected in his classes, by default it will be able to get access only to services declared as public.

A service locator can be defined for Jaxon in the config/services.yaml file, in order to provide access to private services.

services:
  ...
    jaxon.service_locator:
        public: true
        class: Symfony\Component\DependencyInjection\ServiceLocator
        tags: ['container.service_locator']
        arguments:
            -
                Twig\Environment: '@twig'

The service locator must be declared as public, and take all the services that can be passed to Jaxon classes as arguments. See the Symfony service locators documentation.

Twig functions

This extension provides the following Twig functions to insert Jaxon js and css codes in the pages that need to show Jaxon related content.

// templates/demo/index.html.twig

<!-- In page header -->
{{ jxnCss() }}
</head>

<body>

<!-- Page content here -->

</body>

<!-- In page footer -->
{{ jxnJs() }}

{{ jxnScript() }}

Call factories

This extension registers the following Twig functions for Jaxon call factories functions.

Note

In the following examples, the rqAppTest template variable is set to the value rq(Demo\Ajax\App\AppTest::class).

The jxnBind function attaches a UI component to a DOM element, while the jxnHtml function displays a component HTML code in a view.

    <div class="col-md-12" {{ jxnBind(rqAppTest) }}>
        {{ jxnHtml(rqAppTest) }}
    </div>

The jxnPagination function displays pagination links in a view.

    <div class="col-md-12" {{ jxnPagination(rqAppTest) }}>
    </div>

The jxnOn function binds an event on a DOM element to a Javascript call defined with a call factory.

    <select class="form-select"
        {{ jxnOn('change', rqAppTest.setColor(jq().val())) }}>
        <option value="black" selected="selected">Black</option>
        <option value="red">Red</option>
        <option value="green">Green</option>
        <option value="blue">Blue</option>
    </select>

The jxnClick function is a shortcut to define a handler for the click event.

    <button type="button" class="btn btn-primary"
        {{ jxnClick(rqAppTest.sayHello(true)) }}>Click me</button>

The jxnEvent function defines a set of events handlers on the children of a DOM element, using jQuery selectors.

    <div class="row" {{ jxnEvent([
        ['.app-color-choice', 'change', rqAppTest.setColor(jq().val())]
        ['.ext-color-choice', 'change', rqExtTest.setColor(jq().val())]
    ]) }}>
        <div class="col-md-12">
            <select class="form-control app-color-choice">
                <option value="black" selected="selected">Black</option>
                <option value="red">Red</option>
                <option value="green">Green</option>
                <option value="blue">Blue</option>
            </select>
        </div>
        <div class="col-md-12">
            <select class="form-control ext-color-choice">
                <option value="black" selected="selected">Black</option>
                <option value="red">Red</option>
                <option value="green">Green</option>
                <option value="blue">Blue</option>
            </select>
        </div>
    </div>

The jxnEvent function takes as parameter an array in which each entry is an array with a jQuery selector, an event and a call factory.

Contribute

Issue Tracker: github.com/jaxon-php/jaxon-symfony/issues
Source Code: github.com/jaxon-php/jaxon-symfony

License

The package is licensed under the BSD license.

jaxon-php/jaxon-symfony 适用场景与选型建议

jaxon-php/jaxon-symfony 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1.32k 次下载、GitHub Stars 达 3，最近一次更新时间为 2016 年 06 月 15 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「symfony」「php」「ajax」「Jaxon」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 jaxon-php/jaxon-symfony 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 jaxon-php/jaxon-symfony 我们能提供哪些服务？

定制开发 / 二次开发

基于 jaxon-php/jaxon-symfony 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 jaxon-php/jaxon-symfony 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

ufo-cms/json-rpc-bundle 5

The bundle for easy using json-rpc api on your project

ediasoft/mink-selenium4-driver 0

Selenium4 (WebDriver) driver for Mink framework

penance316/laravel-ajax-only-middleware 1

laravel middleware to allow ajax only calls

migliori/sitemap-crawler 3

Sitemap crawler/generator. For the given URL it will return sitemap XML file with URLs and images.

michaelking0/datatable 0

This is a laravel 4 package for the server and client side of datatables at http://datatables.net/

yoanbernabeu/daplos-bundle 1

Bundle Symfony DaplosBundle

jaxon-php/jaxon-symfony

包简介

关键字：