README

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

概述

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

提供了以下缓存处理器的实现。

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

分组

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

JTT

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

快速入门

安装

通过 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 全栈框架和包注册）来引用可用的配置值。此外，此包提供了一个裸的 console 可执行文件，可以通过以下命令调用。

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参考网站使用名为Sami的快速、可靠且功能强大的CLI工具自动生成。它已在大型的复杂项目中进行了严格和定期的测试，例如在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”该主题。

代码

在使用此软件包期间，您创建了额外的功能？将其发送回上游！不要犹豫提交拉取请求！除了贡献指南中概述的简要要求之外，您的想象力是唯一的限制。

许可

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

其他链接

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