包简介

A Component Renderer for PHP

README 文档

README

A Component Renderer for PHP

Mosaic is a state-of-the-art server-side rendering engine for PHP. It offers an enhanced approach to efficiently and flexibly build and render UI components. Designed specifically for PHP developers, it blends seamlessly with the language’s native capabilities to deliver a rich, component-oriented development experience.

Key Advantages

Designed for PHP Developers

PHP-Native Experience: Tailored for PHP without requiring adherence to an MVC model, Mosaic integrates smoothly into PHP projects, leveraging the language's strengths.

Flexible Component Types

Versatile Component Strategies: Beyond mere template rendering, Mosaic supports closures, fragments, and renderable objects, promoting modular and reusable design practices.

Extensible and Customizable

Custom Strategies Out-of-the-Box: The library enables custom rendering strategies for unmatched flexibility, perfect for projects with unique rendering needs.

Lightweight and Performant

Minimal Overhead: Designed to be lean, Mosaic delivers exceptional performance, suitable for projects ranging from small to large scale.

Focused on Server-Side Rendering

Optimized for Server-Side Efficiency: Exclusively targeting server-side rendering, it exploits server capabilities for rapid response times and efficient resource use.

Installation

Install through Composer:

composer require robertkleinschuster/mosaic

Usage

Here are examples for supported component types:

String Components

Handle simple strings:

$renderer->render("Hello, world");

Strings are escaped by default, to render html use a fragment.

Fragment Components

Compose UI fragments:

$fragment = $renderer->fragment('<div>Hello, world</div>');
$renderer->render($fragment);

Closure Components

Render PHP closures dynamically:

$renderer->render(function ($data) {
    return "Hello, " . $data['name'];
}, ['name' => 'world']);

The return value is evaluated as a component.

Iterable Components

Loops over iterable of components:

$items = ['item1', 'item2', 'item3'];
$renderer->render($items);

This is typically used with the PHP generator syntax:

$items = ['item1', 'item2', 'item3'];
$renderer->render(function() {
    yield "first\n",
    yield "second\n",
    yield "third\n",
});

Renderable Components

Utilize objects implementing the Renderable interface:

class MyComponent implements \Mosaic\Renderable {
    public function render(\Mosaic\Renderer $renderer, $data) {
        yield $renderer->fragment("<div>Hello, {$data['name']}</div>");
    }
}
$renderer->render(new MyComponent(), ['name' => 'world']);

In this example the PHP generator syntax is used to yield a child HTML fragment.

Attribute Components

Wrap a class of closure another component using PHP-8 attributes.

#[Attribute]
class MyWrapper implements \Mosaic\RenderableAttribute {
    public function render(\Mosaic\Renderer $renderer, mixed $children, mixed $data){
        return $renderer->fragment(<<<HTML
<p class="wrapper">
    {$renderer->render($children, $data)}
</p>
HTML
);
    }
}

$renderer->render(#[MyWrapper] fn() => 'Hello world!')

The string "Hello world!" will now be rendered inside the paragraph defined in the MyWrapper component.

Passing parameters to components

$renderer->render(fn(string $name) => "Hello $name!", name: 'world')

Extending Mosaic

Its design allows for straightforward expansion, enabling developers to create custom rendering strategies, helper utilities, and more to meet specific application requirements.

Running Tests

To execute the test suite, run the appropriate command in your CLI.

Contributing

Contributions are highly appreciated, whether through issue reporting, feature suggestions, or direct code contributions.

License

Distributed under the MIT License. See the LICENSE file for more information.

Getting Help

For questions, issues, or assistance, please open an issue on GitHub.

robertkleinschuster/mosaic 适用场景与选型建议

robertkleinschuster/mosaic 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 95 次下载、GitHub Stars 达 0，最近一次更新时间为 2024 年 03 月 05 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 robertkleinschuster/mosaic 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 robertkleinschuster/mosaic 我们能提供哪些服务？

定制开发 / 二次开发

基于 robertkleinschuster/mosaic 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

robertkleinschuster/mosaic

包简介