README

概述

欢迎！ The src-run/wonka-bundle 包提供以下功能

一组旨在简化Symfony组件打包的类和接口，包括高级组件配置助手、内核编译器传递等

分组

我们使用类似Willy Wonka的命名规范为我们的包分组命名。此包是wonka组的一部分，该组是一组专注于“核心反射基类”和相关功能的包。

如果您手头有太多时间，欢迎您研究一些关于这个特定组无用的细节。

JTT

此包代表一个大型开源代码集合中的一个项目，这些代码在“SR”命名空间下发布，包括许多框架无关的库、一组Symfony组件和一些单独的发布。该项目由以下人员编写和维护：

快速入门

安装

通过使用Composer CLI明确要求获取代码，或者通过编辑您的composer.json以反映依赖关系并更新您的项目要求。例如，要使用CLI明确要求此项目，请使用以下命令。

$ composer require src-run/wonka-bundle

或者，要将此项目添加到您的“composer.json”文件中，请将以下内容添加到“require”部分。

require: {
	"src-run/wonka-bundle": "dev-master"
}

注意：不建议使用“dev-master”约束。请意识到这样做可能会允许包含向后不兼容的破坏性更改的发布被拉入。相反，使用语义版本控制并明确指定要求是良好的做法。例如，要要求版本1.0，您将使用^1.0。

要启用组件，请在您的Symfony应用程序内核中将其注册，通过在组件数组中实例化ScribeWonkaBundle。

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new SR\WonkaBundle\WonkaBundle(),
        ];
        // ...
    }
}

配置

可以通过使用Symfony控制台命令app/console（假设使用Symfony全栈框架和组件注册）来引用可用的配置值。此外，此组件提供了一个裸露的控制台可执行文件，可以通过调用以下内容来调用。

bin/wonka config:dump-reference scribe_wonka

参考

API 文档

此包的API参考可在我们的文档网站上找到（请参阅以下“附加链接”部分中表中的“参考”行）。所有API文档都会在git push事件发生时自动针对master分支编译。

计划提供特定版本的静态API参考，并在此包成熟并达到1.0版本时发布。.

上述API参考网站是使用名为Sami的可靠且功能完善的CLI工具自动生成的。它经过严格和定期的测试，并被用于一些大型项目，如Symfony全栈框架（https://src.run/go/symfony-api>），以及一些小型项目，如Twig（https://src.run/go/twig-api>）。请参阅Sami的存储库页面以了解如何在您的项目中使用。

示例/教程

目前，除本README文件（本身也是从模板生成的）之外，没有“人工编写的”文档。待项目稳定、可用工时充足以及外部用户实际需求，我们可能会发布一个包含官方文档、教程和额外资源的Read the Docs页面。

贡献

讨论

如果您想进行一般性咨询或讨论一个广泛的主题或想法，请在Freenode上找到“robfrawley”。他乐于讨论语言层面的想法、项目可能的新方向、新兴技术，甚至是天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中尽可能提供详细信息。如果您几天内没有收到回复，请随时“ping”该话题（有时GitHub通知电子邮件会遗漏）。

代码

在利用此包的同时，您创建了额外的功能？太棒了：将其发送回上游！不要犹豫提交pull request！您的想象力以及我们CONTRIBUTING.md文件中概述的要求是唯一的限制。

许可

本项目采用MIT许可证，这是一个由FSF和OSI批准的、与GPL兼容的宽松的免费软件许可证。请查阅与源代码一起分发的LICENSE文件以获取更多信息。

src-run / wonka-bundle

维护者

详细信息

README

概述

分组

JTT

快速入门

安装

配置

参考

API 文档

示例/教程

贡献

讨论

问题

代码

许可

附加链接