mamuz/mamuz-blog

为ZF2和Doctrine提供博客功能

1.6.0 2015-08-20 19:21 UTC

This package is auto-updated.

Last update: 2024-08-24 07:49:07 UTC


README

Build Status Coverage Status Scrutinizer Code Quality SensioLabsInsight HHVM Status Dependency Status

Latest Stable Version Latest Unstable Version Total Downloads License

特性

  • 本模块基于ZF2和Doctrine2提供博客功能。
  • 文章通过Markdown解析器渲染。
  • 文章可打标签和搜索。
  • 提供文章列表和标签列表。
  • 通过加密的标识来保护指向特定文章的链接。
  • 链接也以slugified文章标题结束,以符合SEO。
  • 链接是永久链接。
  • 视图与twitter-Bootstrap兼容。

安装

推荐通过mamuz/mamuz-blog安装,通过composer添加依赖到你的composer.json文件中。

{
    "require": {
        "mamuz/mamuz-blog": "*"
    }
}

之后运行composer update,并将MamuzBlog添加到./config/application.config.php文件中的modules中,以启用此模块。

// ...
    'modules' => array(
        'MamuzBlog',
    ),

本模块基于DoctrineORMModule,请确保你已经配置了数据库连接

使用DoctrineORMModule提供的命令行工具创建数据库表。

./vendor/bin/doctrine-module orm:schema-tool:update

配置

为超链接加密文章标识

加密由hashids/hashids支持,需要通过复制./vendor/mamuz-blog/config/crypt.local.php.dist./config/autoload/crypt.local.php进行配置。确保该文件不在版本控制之下。你需要做的只是将salt值更改为任何复杂的字符串。

默认配置

除了标识加密的配置,该模块可以直接使用,但你可以通过在./config/autoload目录中添加配置文件来覆盖默认配置。默认配置请参见module.config.php

分页

文章和标签列表包括分页功能,将视图分为默认范围。默认范围可以通过在./config/autoload目录中添加配置文件来覆盖。

文章

文章列表由路由blogPublishedPosts提供,默认范围为两个项目。

标签

标签列表由路由blogTags提供,默认范围为10个项目。

创建新文章

MamuzBlogPost仓库中创建实体,并在相关的MamuzBlogTag中对其进行标记。

计划提供用于此的Admin模块。

工作流程

如果通过发布标志和加密的标识找到特定文章的路由成功,则将文章内容作为新视图模型以Markdown格式响应,否则将向HTTP响应对象设置404状态码。

事件

为了简单起见,使用Event表示FQN MamuzBlog\EventManager\Event

以下事件由Event::IDENTIFIER mamuz-blog触发

术语

  • 文章:关于任何问题的已发布文章,按时间顺序列在博客中。
  • 标签:将相关文章分组到特定问题的类别。
  • 永久链接:可读且不可更改的指向特定文章或特定标签的文章列表的链接。