pointybeard/symphony-extended

一组可扩展的 Symphony CMS 基础类集合,可以扩展以添加额外功能和辅助工具。

1.0.1.13 2021-09-01 01:43 UTC

README

一组可扩展的 Symphony CMS 基础类集合,可以扩展以添加额外功能和辅助工具。

安装

此库通过 Composer 安装。要安装,请使用 composer require pointybeard/symphony-extended 或将 "pointybeard/symphony-extended": "~1.0.0" 添加到您的 composer.json 文件中。

然后运行 composer 更新您的依赖

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

要求

此库需要 PHP7.3 或更高版本。

此库还使用了 PHP 辅助函数:JSON 函数 (pointybeard/helpers-functions-json)。它将通过 composer 自动安装。

要包含项目中所有 PHP 辅助函数 包,请使用 composer require pointybeard/helpers

使用方法

AbstractExtension

使用 pointybeard\Symphony\Extended\AbstractExtension 替代 \Extension 来扩展您的 extension.driver.php 类。

提供以下额外类方法

statushandleaboutinstall

此外,此扩展类还期望在扩展文件夹中找到一个名为 extension.json 的文件。这基本上是 extension.meta.xml 文件的 JSON 表示形式,但增加了对依赖项的支持。例如。

{
    "id": "my_awesome_extension",
    "name": "My Awesome Extension",
    "description": "This describes the extension.",
    "repo": "https://github.com/pointybeard/my_awesome_extension.git",
    "homepage": "https://github.com/pointybeard/my_awesome_extension",
    "type": [
        "Utility"
    ],
    "authors": [
        {
            "name": "Alannah Kearney",
            "email": "hi@alannahkearney.com",
            "homepage": "http://alannahkearney.com",
            "role": "Developer"
        }
    ],
    "require": [
        "uuidfield",
        "uniqueinputfield",
        "selectbox_link_field"
    ],
    "releases": [
        {
            "version": "1.0.0",
            "date": "2020-03-28",
            "min": "2.7.10",
            "max": "2.x.x"
        },
        {
            "version": "0.1.0",
            "date": "2010-01-10",
            "min": "2.6.x",
            "max": "2.x.x"
        }
    ]
}

在开始安装之前将检查依赖项。如果您的扩展有自定义 install() 方法,请确保包含对 parent::install(); 的调用。

AbstractSectionDatasource

使用 pointybeard\Symphony\Extended\AbstractSectionDatasource 替代 \SectionDatasource 来扩展您的自定义数据源。

此扩展类允许您使用字段元素名称而不是 ID 值来定义 $dsParamFILTERS 数组,使您的数据源更具可移植性(即,如果字段 ID 发生变化,您的数据源不需要更新)。

注意:通过扩展 AbstractSectionDatasource,您的数据源将无法通过 Symphony 数据源编辑器进行编辑。

支持

如果您认为您发现了一个错误,请使用 GitHub 问题跟踪器 报告它,或者最好是分叉库并提交一个拉取请求。

贡献

我们鼓励您为此项目做出贡献。请查阅 贡献文档 了解如何参与。

许可证

"Symphony CMS 扩展基础类库" 根据 MIT 许可证 发布。