Options

Generator Options

Generator configuration arrays generators can contain the following settings:

class

The generator class name to be used. If this value is not set, a corresponding generator will be specified based on the element type.

For Craft’s built-in types:

Element Type	Generator Type	Class
Entry	EntryGenerator	panlatent\craft\element\generator\generators\EntryGenerator
User	UserGenerator	panlatent\craft\element\generator\generators\UserGenerator
Category	CategoryGenerator	panlatent\craft\element\generator\generators\CategoryGenerator
Tag	TagGenerator	panlatent\craft\element\generator\generators\TagGenerator

elementType (Required)

The class name of the element type being generated. Craft's built-in element type classes include:

Tip

For Craft's built-in element types, there will be additional parameters Builtin Element Options

• craft\elements\Asset
• craft\elements\Category
• craft\elements\Entry
• craft\elements\GlobalSet
• craft\elements\MatrixBlock
• craft\elements\Tag
• craft\elements\User

'elementType' => craft\elements\Entry::class,

site

Generates the site handle of the element. If this value is not set, it defaults to the primary site.

'site' => 'default',

Currently, the purpose of showing the claim site is to bind the language of the generated content, which will set the language used by Faker.

values (Required)

The callback function used to generate content. Generator obtains the value of the new element through the array returned by the callback function, which includes native attributes and custom fields.

We provide a context parameter to assist in generating values.

'values' => function(\panlatent\craft\element\generator\value\Context $ctx) {
    return [];
},

Context

Context is a helper class that helps you generate values.

• $ctx->faker provides common methods for generating data, which you can extend. Powered by fakerphp/faker
• $ctx->openai provides content generation powered by OpenAI/ChatGPT.
• $ctx->random Provides the ability to extract data from common data (fields, files, etc.).

The preferred way to generate a value is to get it from Faker.

Faker

'values' => function(\panlatent\craft\element\generator\value\Context $ctx) {
    return [
        'companyName' = $ctx->faker->company();
    ];
},

Faker is ready to use out of the box, please refer to its documentation for specific usage. Faker Docs

Only specific issues are listed here.

Language

The language used by Faker is determined by the generator, and the site language is used by default, determined according to site. We can specify Faker language separately to deal with different requirements.

Tip

The context here is in a generator configuration, not values. Reference context

'context' => [
    'components' => ['faker' => ['locale' => 'en_US']],
]

There are some differences between Faker's language code and Craft's language code, and we've done some work to patch this, but can't cover every situation.

You can define a mapping array to handle this edge case:

'context' => [
    'components' => [
        'faker' => [
            'languages' => [
                'en' => 'en_US',
            ]
        ]
    ],
],

The keys are Craft language codes and the values are Faker language codes.

Register Provider

Tip

Registering the same class name (full class name) overrides the built-in provider.

GlobalIn Generator

<?php

use panlatent\craft\element\generator\value\Faker;

Event::on(Faker::class, Faker::EVENT_REGISTER_PROVIDERS, function(RegisterProvidersEvent $event) {
    $event->providers[] = YourProvider::class;
})

'context' => [
    'components' => [
        'faker' => [
            'providers' => [
                YourProvider::class,
            ]
        ],
    ]
],

Random

Random is able to randomly select some data from elements, options or even CSV.

OpenAI

Warning

Currently, this is an experimental feature. Feedback and suggestions are always welcome.

We provide a simple component to call OpenAI API and compatible APIs. Use $ctx->openai->generate() to generate complex content.

an example of generating a job entry:

'values' => function (Context $ctx) {
    $title = $ctx->faker->jobTitle();
    return [
        'title' => $title,
        'details' => $ctx->openai->generate('Write a job detail, your title is a' . $title),
    ];
},

To use this feature, you must configure your API Key, which can be done in the following two ways:

Current GeneratorGlobal

'context' => [
    'components' => [
        'openai' => [
            'apiKey' => 'your-api-key',
        ]
    ]
]

'default' => [
    'context' => [
        'components' => [
            'openai' => [
                'apiKey' => 'your-api-key',
            ]
        ]
    ]
]

If you want to change the defaults or use the compatibility API, you may need to configure baseUrl and model. Environment variables are always available and you can configure them once and for all:

'openai' => [
    'baseUrl' => '$OPENAI_API_BASE_URL',
    'apiKey' => '$OPENAI_API_KEY',
    'model' => '$OPENAI_API_MODEL',
]

Then, add them in an environment variable or .env file.

context

Defines a configuration array of Context objects. The Context class is actually a Service Locator. Just like an application, you can modify components or add new components by configuring components.

The class key is the type of Context class. If the value is not set, it defaults to panlatent\craft\element\generator\value\Context.

'context' => [
    'class' => panlatent\craft\element\generator\value\Context::class,
    'components' => [
    ],
],

scenario

defaultValues

mode

Default Options

Default configuration arrays default can contain the following settings: