final class DiscoveryConfigDefinition extends AbstractConfigDefinition (View source)

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

static string

Returns the stable module key used to group this definition.

string
robotsRule(string $agent, array $allow = [], array $disallow = [])
sitemapRouteItem(string $name, array $params = [], string|DateTimeInterface|null $lastmod = null, string|null $changefreq = null, float|null $priority = null)

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

No description

moduleKey

static string moduleKey()

Returns the stable module key used to group this definition.

Return Value

string

robotsEnabled

DiscoveryConfigDefinition robotsEnabled(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

DiscoveryConfigDefinition

robotsDisabled

No description

robotsRoute

DiscoveryConfigDefinition robotsRoute(string $route)

No description

Parameters

string $route

Return Value

DiscoveryConfigDefinition

robotsHeaderEnabled

DiscoveryConfigDefinition robotsHeaderEnabled(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

DiscoveryConfigDefinition

robotsHeaderDisabled

DiscoveryConfigDefinition robotsHeaderDisabled()

No description

robotsHeaderGenerator

DiscoveryConfigDefinition robotsHeaderGenerator(string $generator)

No description

Parameters

string $generator

Return Value

DiscoveryConfigDefinition

robotsHeaderDateFormat

DiscoveryConfigDefinition robotsHeaderDateFormat(string $dateFormat)

No description

Parameters

string $dateFormat

Return Value

DiscoveryConfigDefinition

robotsRule

DiscoveryConfigDefinition robotsRule(string $agent, array $allow = [], array $disallow = [])

No description

Parameters

string $agent
array $allow
array $disallow

Return Value

DiscoveryConfigDefinition

robotsSitemaps

DiscoveryConfigDefinition robotsSitemaps(array $sitemaps)

No description

Parameters

array $sitemaps

Return Value

DiscoveryConfigDefinition

robotsSitemap

DiscoveryConfigDefinition robotsSitemap(string $sitemap)

No description

Parameters

string $sitemap

Return Value

DiscoveryConfigDefinition

sitemapEnabled

DiscoveryConfigDefinition sitemapEnabled(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

DiscoveryConfigDefinition

sitemapDisabled

No description

sitemapRoute

DiscoveryConfigDefinition sitemapRoute(string $route)

No description

Parameters

string $route

Return Value

DiscoveryConfigDefinition

sitemapCliOutput

DiscoveryConfigDefinition sitemapCliOutput(bool $enabled = true)

No description

Parameters

bool $enabled

Return Value

DiscoveryConfigDefinition

sitemapMode

DiscoveryConfigDefinition sitemapMode(string $mode)

No description

Parameters

string $mode

Return Value

DiscoveryConfigDefinition

sitemapBaseUrl

DiscoveryConfigDefinition sitemapBaseUrl(string|null $baseUrl)

No description

Parameters

string|null $baseUrl

Return Value

DiscoveryConfigDefinition

sitemapRouteItem

DiscoveryConfigDefinition sitemapRouteItem(string $name, array $params = [], string|DateTimeInterface|null $lastmod = null, string|null $changefreq = null, float|null $priority = null)

No description

Parameters

string $name
array $params
string|DateTimeInterface|null $lastmod
string|null $changefreq
float|null $priority

Return Value

DiscoveryConfigDefinition

sitemapRoutes

DiscoveryConfigDefinition sitemapRoutes(array $routes)

No description

Parameters

array $routes

Return Value

DiscoveryConfigDefinition

sitemapProvider

DiscoveryConfigDefinition sitemapProvider(string $providerClass)

No description

Parameters

string $providerClass

Return Value

DiscoveryConfigDefinition

sitemapProviders

DiscoveryConfigDefinition sitemapProviders(array $providerClasses)

No description

Parameters

array $providerClasses

Return Value

DiscoveryConfigDefinition

sitemapCachePath

DiscoveryConfigDefinition sitemapCachePath(string $cachePath)

No description

Parameters

string $cachePath

Return Value

DiscoveryConfigDefinition

sitemapFilename

DiscoveryConfigDefinition sitemapFilename(string $filename)

No description

Parameters

string $filename

Return Value

DiscoveryConfigDefinition

sitemapIndexFilename

DiscoveryConfigDefinition sitemapIndexFilename(string $filename)

No description

Parameters

string $filename

Return Value

DiscoveryConfigDefinition

sitemapGzip

DiscoveryConfigDefinition sitemapGzip(bool $gzip = true)

No description

Parameters

bool $gzip

Return Value

DiscoveryConfigDefinition

sitemapMaxUrlsPerFile

DiscoveryConfigDefinition sitemapMaxUrlsPerFile(int $maxUrlsPerFile)

No description

Parameters

int $maxUrlsPerFile

Return Value

DiscoveryConfigDefinition

sitemapMaxUncompressedBytes

DiscoveryConfigDefinition sitemapMaxUncompressedBytes(int $maxUncompressedBytes)

No description

Parameters

int $maxUncompressedBytes

Return Value

DiscoveryConfigDefinition

sitemapDeduplicate

DiscoveryConfigDefinition sitemapDeduplicate(bool $deduplicate = true)

No description

Parameters

bool $deduplicate

Return Value

DiscoveryConfigDefinition

sitemapOnInvalidUrl

DiscoveryConfigDefinition sitemapOnInvalidUrl(string $mode)

No description

Parameters

string $mode

Return Value

DiscoveryConfigDefinition