collective.jsconfiguration 0.1.1

简介

此产品针对需要将JavaScript配置数据或i18n字符串与其Plone产品一起分发的开发者。

注入到页面中的数据可以来自您想要的服务器端配置设置，但大多数情况下，您希望从Plone注册表读取应用程序配置，从页面模板中读取翻译。

工作原理

将在站点的HTML头部注册一个新的小部件。这个小部件通常是空的，并且将不执行任何操作，直到第三方产品注册新的IJSDataProvider适配器。

适配器有三种子类型，选择其中一种取决于您想要在您的附加组件中实现什么。

建议注册命名适配器，这样就可以通过更具体的一个来覆盖注册。在IJSObjectDataProvider的情况下，名称是必需的，因为它用作定义的变量的名称（见下文）。

<script type="text/collective.jsconfiguration.json"
        id="your_adapter_name_if_any">
    {"foo": ... }
</script>

var configuration = $.parseJSON($('#your_adapter_name_if_any').text());

<script type="text/collective.jsconfiguration.xml"
        id="your_adapter_name_if_any">
    <foo data-i18n-label1="Benvenuto"
         data-i18n-label2="Questo è un esempio di traduzione">
         ...
    </foo>
</script>

var label1 = $($('#your_adapter_name_if_any').text()).attr('data-i18n-label1');
var label2 = $($('#your_adapter_name_if_any').text()).attr('data-i18n-label2');

<script type="text/javascript">
if (typeof foo==='undefined') {
    foo = {};
}

foo.bar = {"baz": "Hello World"};
</script>

alert(foo.bar.baz); // whil be "Hello World"

注册新的配置

无论你选择什么，你只需注册一个适配器，该适配器适配当前上下文、请求和当前视图。

一个例子

<adapter
    factory="your.package.adapter.YourXMLAdapter"
    provides="collective.jsconfiguration.interfaces.IDOMDataProvider"
    for="* * *"
    name="your_zml_configuration"
    />

在上面的例子中，配置将被添加到网站的每个页面。

<adapter
    factory="your.package.adapter.AnotherXMLAdapter"
    provides="collective.jsconfiguration.interfaces.IDOMDataProvider"
    for="Products.CMFPlone.interfaces.siteroot.IPloneSiteRoot
         your.package.browser.interfaces.IYourProductLayer
         your.package.browser.interfaces.IYourSpecialView"
    name="your_zml_configuration"
    />

在最后一个例子中，另一个配置将仅在网站根目录添加，仅在注册了第三方浏览器层（通常是：你的附加产品已安装）且仅当调用特定视图时。

由于适配器注册使用与第一个例子相同的名称，因此最后一个注册将在适用时覆盖第一个。

最后，是适配器类

class YourXMLAdapter(object):
    implements(IDOMDataProvider)

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view

    def __call__(self):
        ...

当使用IJSONDataProvider或IJSObjectDataProvider并直接从Plone注册表中读取数据时，你可以依赖collective.regjsonify包，它可以快速帮助你完成这项任务

from collective.regjsonify.interfaces import IJSONifier
from collective.jsconfiguration.interfaces import IJSONDataProvider
from plone.registry.interfaces import IRegistry
from zope.interface import implements

class YourXMLAdapter(object):
    implements(IJSONDataProvider)

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view

    def __call__(self):
        registry = queryUtility(IRegistry)
        settings = registry.forInterface(IMyRegistrySettings)
        return IJSONifier(settings).json()

示例应用

你可以在collective.externalizelink Plone插件中找到所有这些功能。

变更日志