abdounikarim / lorem-ipsum-bundle

快乐的 lorem ipsum

dev-main 2022-10-13 10:19 UTC

This package is auto-updated.

Last update: 2024-10-03 14:29:30 UTC


README

LoremIpsumBundle 是一种将“虚假文本”生成到您的 Symfony 应用程序中的方法,但比您正常的 lorem ipsum 有更多一点乐趣。

使用以下命令安装软件包

composer require knpuniversity/lorem-ipsum-bundle --dev

并且...这就完成了!如果您不使用 Symfony Flex,您还需要在您的 AppKernel.php 文件中启用 KnpU\LoremIpsumBundle\KnpULoremIpsumBundle

用法

此扩展提供了一种生成虚假文本的单个服务,您可以通过使用 KnpUIpsum 类型提示来自动注入。

// src/Controller/SomeController.php

use KnpU\LoremIpsumBundle\KnpUIpsum;
// ...

class SomeController
{
    public function index(KnpUIpsum $knpUIpsum)
    {
        $fakeText = $knpUIpsum->getParagraphs();

        // ...
    }
}

您也可以使用 ID knpu_lorem_ipsum.knpu_ipsum 直接访问此服务。

配置

可以通过创建一个新的 config/packages/knpu_lorem_ipsum.yaml 文件直接配置生成的文本的某些部分。默认值如下

# config/packages/knpu_lorem_ipsum.yaml
knpu_lorem_ipsum:

    # Whether or not you believe in unicorns
    unicorns_are_real:    true

    # How much do you like sunshine?
    min_sunshine:         3

扩展单词列表

如果您感到非常创造性和兴奋,您可以向单词生成器添加自己的单词!

要这样做,创建一个实现 WordProviderInterface 的类

namespace App\Service;

use KnpU\LoremIpsumBundle\WordProviderInterface;

class CustomWordProvider implements WordProviderInterface
{
    public function getWordList(): array
    {
        return ['beach'];
    }
}

并且...这就完成了!如果您使用标准的服务配置,您的新类将自动注册为服务并由系统使用。如果您不这样做,您需要将此类注册为服务并使用 knpu_ipsum_word_provider 标签。

贡献

当然,开源是由每个人为更大的利益贡献一点时间的力量。如果您想看到某个功能或添加您自己的快乐单词,太好了!您可以请求它 - 但创建一个 pull request 是完成工作的更好方式。

无论如何,请放心提交问题或 pull request:所有贡献和问题都受到热烈欢迎 :)