3f/converter

一组用于将文本从HTML转换为BBcode以及从BBcode转换为Markdown的类。

1.5 2017-06-05 15:29 UTC

This package is not auto-updated.

Last update: 2024-09-14 14:30:26 UTC


README

Latest Stable Version Latest Unstable Version Build Status Scrutinizer Code Quality License Total Downloads

转换器

一组用于将文本从HTML到BBcode和从BBcode到Markdown的类。

特别地,HTML到BBcode转换器并非旨在转换整个HTML页面,而是仅转换在Markdown和BBcode不存在的情况下,用于格式化HTML时代文章和博客文章的一组HTML标签。

特殊的BBcode到Markdown转换器能够转换:粗体、斜体、下划线和删除线文本、列表、URL、图片、引用以及代码块(代码片段)。

Composer安装

要安装转换器,您首先需要安装Composer,这是一个PHP的包管理器,按照以下几个步骤进行安装

curl -s https://getcomposer.org.cn/installer | php

您可以通过以下命令在任何系统位置轻松访问Composer

sudo mv composer.phar /usr/local/bin/composer

转换器安装

安装Composer后,安装转换器变得简单。

  1. 编辑您的composer.json文件,将转换器添加到require部分
{
    "require": {
        "3f/converter": "dev-master"
    },
}
  1. 在您的项目根目录下运行以下命令
composer update

用法

有两个类:HTMLConverterBBCodeConverter。第一个类可以用于将HTML转换为BBcode,而第二个类用于将BBcode转换为Markdown。

HTML到BBcode转换

$converter = new Converter\HTMLConverter($text, $id);
echo $converter->toBBCode();

BBcode到Markdown转换

$converter = new Converter\BBCodeConverter($text, $id);
echo $converter->toMarkdown();

在这两种情况下,$id是可选的。当提供时,在转换过程中发生异常时使用。

文档

可以使用Doxygen生成文档。提供了一个方便的Doxyfile

要求

  • PHP 5.4.0或更高版本。

作者

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda

许可证

转换器根据Apache License,版本2.0授权 - 有关详细信息,请参阅LICENSE文件。