README

安装

要在您的项目中使用 CmsSystem 项目，只需将其添加到您的项目目录中，或者通过 Composer 安装它。

composer require portavice/cmssystem

然后添加配置文件

php artisan vendor:publish --provider="Portavice\CmsSystem\CmsSystemServiceProvider"

更新

要更新 CmsSystem 项目，只需执行以下命令：

composer update portavice/cmssystem

然后可以更新配置文件

php artisan vendor:publish --provider="Portavice\CmsSystem\CmsSystemServiceProvider" --tag="config" --force

使用方法

要在您的项目中使用 CmsSystem 类，您需要首先导入它并创建类的实例。

use Portavice\CmsSystem\CmsSystem;

$cms = new CmsSystem();

方法

CmsSystem 类提供了各种方法来替换占位符和操作内容。以下是主要方法：

setContent

public function setContent(string $content): self

设置要替换占位符的内容。

setParams

public function setParams(array $params): self

设置一个可以用于占位符的参数列表。参数作为键值对数组传递。

setParam

public function setParam(string $key, mixed $value): self

设置单个参数，包括指定的键和值。

removeParam

public function removeParam(string $key): self

删除指定键的参数。

replace

public function replace(?string $content = null): string

替换指定内容（或之前设置的内容）中的占位符，并返回结果文本。

splitPattern

public function splitPattern(string $content): array

根据定义的模式将指定内容分割成块，并返回一个包含块的数组。

注意：其他方法为内部方法，由类用于操作占位符。如果您需要执行更高级的定制，则可以使用这些方法。

示例

use Portavice\CmsSystem\CmsSystem;

$cms = new CmsSystem();

$content = "
    {{ var some_variable }}
    {{ if some_condition }}
        This content is shown if 'some_condition' is true.
    {{ else }}
        This content is shown if 'some_condition' is false.
    {{ endif }}
    {{ foreach items as item }}
        {{ item.name }}
    {{ endforeach }}
";

$params = [
    'some_variable' => 'Hello, World!',
    'some_condition' => true,
    'items' => [
        ['name' => 'Item 1'],
        ['name' => 'Item 2'],
        ['name' => 'Item 3'],
],
];

echo $cms->setParams($params)->replace($content);

此示例演示了如何使用 CmsSystem 类替换 $content 中的占位符。然后输出结果文本。

注意

请注意，此 README.md 只提供了 CmsSystem 类的基本概述。有关详细信息和建议的进一步定制，请检查类的源代码并探索可用方法。

作者

CmsSystem 类由 Portavice 开发，并使用 MIT 许可。有关更多信息，请参阅 LICENSE 文件。

报告错误

如果您发现错误或改进建议，请在此存储库中将其作为问题报告。

祝您使用 CmsSystem 时愉快！

许可

MIT 许可（MIT）。有关更多信息，请参阅 许可文件。

开发

如何开发

• 运行 composer install 以安装 PHP 的依赖项。
• 运行 composer cs 以检查代码风格，并在每次提交之前运行 composer csfix 以修复代码风格违规。

代码风格

PHP 代码必须遵循 PSR-12 规范。

我们使用 PHP_CodeSniffer 来检查 PHP 代码风格。