voltel/knpu-lorem-ipsum-bundle

快乐的 "Lorem ipsum" 文本,包含积极的英语单词

安装: 10

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

类型:symfony-bundle

v1.0.0 2021-03-08 12:55 UTC

This package is auto-updated.

Last update: 2024-09-08 21:11:52 UTC


README

这是一个已废弃的项目,不再维护。

此包为您的 Symfony 应用程序添加了生成 "伪造文本"(即单词、句子和段落)的功能,但使用默认单词时带有积极的含义。

此外,它还提供了一个 API 端点来获取此类文本。可以使用插件系统(通过实现特定接口的类)更改单词列表。

该项目是在遵循 Ryan Weaver 在 创建可重用(&惊人)的 Symfony 包 的屏幕录像中展示的一系列分步说明时创建的。

安装

确保已全局安装 Composer,如 Composer 文档中的 安装章节 所述。

使用 Symfony Flex 的应用程序

打开命令行,进入您的项目目录并执行

$ composer require  voltel/knpu-lorem-ipsum-bundle 

不使用 Symfony Flex 的应用程序

步骤 1:下载包

打开命令行,进入您的项目目录并执行以下命令以下载此包的最新稳定版本

$ composer require  voltel/knpu-lorem-ipsum-bundle 

步骤 2:启用包

然后,通过将其添加到项目 config/bundles.php 文件中注册的包列表中,启用该包

// config/bundles.php

return [
    // ...
    KnpU\LoremIpsumBundle\KnpULoremIpsumBundle::class => ['all' => true],
];

用法

此包提供了一个用于生成伪造文本的单个服务,您可以通过使用 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 you believe in unicorns or not
    unicorns_are_real:    true

    # Min count of times the word "shunshine" should appear in a paragraph.
    min_sunshine:         3

扩展单词列表

如果您感到特别有创意和兴奋,可以向单词生成器添加您自己的单词!

为此,创建一个实现 WordProviderInterface 的类

namespace App\Service;

use KnpU\LoremIpsumBundle\WordProviderInterface;

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

然后...这就对了!如果您使用的是标准服务配置,则您的新类将自动注册为服务并供系统使用。如果您不是这样做的,则需要将此类注册为服务,并将其标记为 knpu_ipsum_word_provider

贡献

以下文本最初位于屏幕录像中

Of course, open source is fueled by everyone's ability to give just a little bit
of their time for the greater good. If you'd like to see a feature or add some of
your *own* happy words, awesome! You can request it - but creating a pull request
is an even better way to get things done.

Either way, please feel comfortable submitting issues or pull requests: all contributions
and questions are warmly appreciated :).

但请注意,这是一个已废弃的项目,不再维护。