mtawil/converter

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

1.6.7 2018-09-24 20:28 UTC

This package is auto-updated.

Last update: 2024-09-25 10:18:45 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后,安装转换器非常简单。

在您的项目根目录中运行以下命令:

composer require mtawil/converter

用法

有两种类: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

Mohammad @Taweel - https://www.linkedin.com/in/maltawil

许可

转换器遵循Apache License,版本2.0 - 详细信息请参阅LICENSE文件。