README

持续集成	代码质量审查	单元测试覆盖率

概述

欢迎！scr-be/teavee-object-cache-bundle 软件包提供了一种简单、健壮且可扩展的缓存抽象层，通过 Symfony 服务标签注册支持自定义后端。

以下是一些缓存处理器的实现。

• Memcached（需要 memcached 扩展）
• Mock（提供始终为真的模拟处理器）
• Redis（需要 redis 扩展）

分组

该软件包是 teavee 组的一部分（说明），该组由其他专注于 媒体、HTML、内容、生成器 和相关功能的发布物组成。

JTT

该软件包代表一个项目，该项目位于一个 大型开源代码集合 中，这些代码在 Scribe 命名空间下发布，包括框架无关的库和一些 Symfony 扩展。这些项目由 Rob Frawley 2nd 和 协作者 编写和维护，通常得到 Scribe Inc 的支持。

快速开始

安装

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

$ composer require scr-be/teavee-object-cache-bundle

要启用该扩展包，通过在扩展包数组中实例化 ScribeTeaveeObjectCacheBundle 来将其注册到您的 Symfony 应用程序内核中。

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

配置

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

bin/teavee-object-cache config:dump-reference scribe_teavee_object_cache

参考

API 文档

本包的API文档可在以下网址查看：scr.be/teavee-object-cache-bundle/api，（以及下方通过《参考》徽章链接，该徽章位于《附加链接》标题下）。所有API参考都是基于master Git分支构建的，并在每次Git推送时自动更新——一旦本包成熟，将为特定版本提供API参考。

整个API参考网站使用一个快速、可靠且功能完善的CLI工具自动生成，该工具名为Sami。它通过在大型、复杂的项目中使用进行严格和定期的测试，如Symfony全栈框架（参见：scr.be/go/api-ref-symfony），以及在小项目如Twig中的使用（参见：scr.be/go/api-ref-twig）。参考Sami的GitHub页面，了解如何将其用于您自己的项目！

示例/教程

目前，除了这份README之外，没有“人工编写”的文档。待包稳定且有可用资源时，将发布一个包含额外信息和教程的RTD（Read the Docs）页面，包括在Symfony框架中的实际使用案例。

贡献

讨论

对于一般性咨询或讨论广泛的话题或想法，您可以在Freenode上找到robfrawley。还有一个#scribe频道，可以通过以下链接加入：irc.choopa.net:6669/scribe。

问题

要报告问题或请求新功能，请使用GitHub或GitLab发起讨论。尽可能提供详细信息，以便快速解决问题。如果您几天内没有收到回复，请随时“ping”该话题。

代码

在使用本包的过程中创建了额外的功能？请将其发送回源！请勿犹豫提交pull request！除了在《贡献指南》中概述的简要要求之外，您的想象力是唯一的限制。

许可

本项目遵循MIT许可，这是一个FSF/OSI-批准且与GPL兼容的、宽松的免费软件许可。请参阅与源代码一起分发的LICENSE文件以获取更多信息。

附加链接

目的	状态
稳定版本
开发版本
许可
参考