RunConfiguration 

namespace	bhenk\doc2rst\globals
predicates	Cloneable \| Instantiable
implements	Stringable \| ContainerInterface
extends	AbstractStaticContainer
hierarchy	RunConfiguration -> AbstractStaticContainer

Container for run-time configuration settings

This class represents -and is loaded with- the d2r-conf.php file in the docs folder. It uses the enum RC as a safeguard for correctly spelled property names.

@inheritdoc

Base class for static container classes that load their values from an Array

Implementations of this abstract static container use a UnitEnum to correlate their properties to keys in the array in a way that

property name == enum->name == key
method name == [get|set] + camelcase(property name)

@inheritdoc from class AbstractStaticContainer

@inheritdoc

Describes the interface of a container that exposes methods to read its entries

@inheritdoc from interface ContainerInterface

Constants 

RunConfiguration::DEFAULT_DOWNLOADABLES 

predicates

public

array(4) { [0]=> string(4) ".txt" [1]=> string(4) ".csv" [2]=> string(3) ".js" [3]=> s ...

Methods 

RunConfiguration::enumForName 

predicates	public \| static
implements	AbstractStaticContainer::enumForName

Gets the RC-enum case for the corresponding RC-enum name

@inheritdoc

Returns the enum case for the given param $id or null if it does not exist

param string $id - enum name

return UnitEnum | null - enum case with the given param $id or null

@inheritdoc from method AbstractStaticContainer::enumForName

uses RC

public static function enumForName(
      Parameter #0 [ <required> string $id ]
 ): ?UnitEnum

param string $id - one of the names of enum cases in RC

return ?UnitEnum - the corresponding enum case or null if param $id not an RC-name

RunConfiguration::reset 

predicates	public \| static
implements	AbstractStaticContainer::reset

Reset properties to their defaults

The reset action of this class is superimposed on that of the parent class:

@inheritdoc

Reset the container to a neutral state (not necessarily to its original state)

return array - representing the neutral state

throws ContainerException

@inheritdoc from method AbstractStaticContainer::reset

A call to reset on this class will reset it to its original state.

public static function reset(): array

return array - the configuration as an array

throws ContainerException

RunConfiguration::toString 

predicates

public | static

public static function toString(): string

return string

RunConfiguration::getApplicationRoot 

predicates

public | static

public static function getApplicationRoot(): ?string

return ?string

RunConfiguration::setApplicationRoot 

predicates

public | static

public static function setApplicationRoot(
      Parameter #0 [ <required> ?string $application_root ]
 ): void

param ?string $application_root

return void

RunConfiguration::getVendorDirectory 

predicates

public | static

public static function getVendorDirectory(): ?string

return ?string

RunConfiguration::setVendorDirectory 

predicates

public | static

public static function setVendorDirectory(
      Parameter #0 [ <required> ?string $vendor_directory ]
 ): void

param ?string $vendor_directory

return void

RunConfiguration::getBootstrapFile 

predicates

public | static

public static function getBootstrapFile(): ?string

return ?string

RunConfiguration::setBootstrapFile 

predicates

public | static

public static function setBootstrapFile(
      Parameter #0 [ <required> ?string $bootstrap_file ]
 ): void

param ?string $bootstrap_file

return void

RunConfiguration::getDocRoot 

predicates

public | static

public static function getDocRoot(): ?string

return ?string

RunConfiguration::setDocRoot 

predicates

public | static

public static function setDocRoot(
      Parameter #0 [ <required> ?string $doc_root ]
 ): void

param ?string $doc_root

return void

RunConfiguration::getApiDirectory 

predicates

public | static

public static function getApiDirectory(): ?string

return ?string

RunConfiguration::setApiDirectory 

predicates

public | static

public static function setApiDirectory(
      Parameter #0 [ <required> ?string $api_directory ]
 ): void

param ?string $api_directory

return void

RunConfiguration::getShowVisibility 

predicates

public | static

public static function getShowVisibility(): int

return int

RunConfiguration::setShowVisibility 

predicates

public | static

public static function setShowVisibility(
      Parameter #0 [ <required> int $visibility ]
 ): void

param int $visibility

return void

RunConfiguration::getLogLevel 

predicates

public | static

public static function getLogLevel(): ?int

return ?int

RunConfiguration::setLogLevel 

predicates

public | static

public static function setLogLevel(
      Parameter #0 [ <required> int $log_level ]
 ): void

param int $log_level

return void

RunConfiguration::getExcludes 

predicates

public | static

public static function getExcludes(): array

return array

RunConfiguration::setExcludes 

predicates

public | static

public static function setExcludes(
      Parameter #0 [ <required> array $excludes ]
 ): void

param array $excludes

return void

RunConfiguration::addExcluded 

predicates

public | static

public static function addExcluded(
      Parameter #0 [ <required> string $path ]
 ): void

param string $path

return void

RunConfiguration::getApiDocsTitle 

predicates

public | static

public static function getApiDocsTitle(): ?string

return ?string

RunConfiguration::setApiDocsTitle 

predicates

public | static

public static function setApiDocsTitle(
      Parameter #0 [ <required> ?string $api_docs_title ]
 ): void

param ?string $api_docs_title

return void

RunConfiguration::getToctreeMaxDepth 

predicates

public | static

public static function getToctreeMaxDepth(): int

return int

RunConfiguration::setToctreeMaxDepth 

predicates

public | static

public static function setToctreeMaxDepth(
      Parameter #0 [ <required> int $toctree_max_depth ]
 ): void

param int $toctree_max_depth

return void

RunConfiguration::getToctreeTitlesOnly 

predicates

public | static

public static function getToctreeTitlesOnly(): bool

return bool

RunConfiguration::setToctreeTitlesOnly 

predicates

public | static

public static function setToctreeTitlesOnly(
      Parameter #0 [ <required> bool $toctree_titles_only ]
 ): void

param bool $toctree_titles_only

return void

RunConfiguration::getShowClassContents 

predicates

public | static

public static function getShowClassContents(): bool

return bool

RunConfiguration::setShowClassContents 

predicates

public | static

public static function setShowClassContents(
      Parameter #0 [ <required> bool $show_class_contents ]
 ): void

param bool $show_class_contents

return void

RunConfiguration::getUserProvidedLinks 

predicates

public | static

public static function getUserProvidedLinks(): array

return array

RunConfiguration::setUserProvidedLinks 

predicates

public | static

public static function setUserProvidedLinks(
      Parameter #0 [ <required> array $user_provided_links ]
 ): void

param array $user_provided_links

return void

RunConfiguration::addUserProvidedLink 

predicates

public | static

public static function addUserProvidedLink(
      Parameter #0 [ <required> string $key ]
      Parameter #1 [ <required> string $location ]
 )

param string $key

param string $location

RunConfiguration::getLinkToSources 

predicates

public | static

public static function getLinkToSources(): bool

return bool

RunConfiguration::setLinkToSources 

predicates

public | static

public static function setLinkToSources(
      Parameter #0 [ <required> bool $link_to_sources ]
 ): void

param bool $link_to_sources

return void

RunConfiguration::getLinkToSearchEngine 

predicates

public | static

public static function getLinkToSearchEngine(): bool

return bool

RunConfiguration::setLinkToSearchEngine 

predicates

public | static

public static function setLinkToSearchEngine(
      Parameter #0 [ <required> bool $link_to_search_engine ]
 ): void

param bool $link_to_search_engine

return void

RunConfiguration::getDownloadFileExt 

predicates

public | static

public static function getDownloadFileExt(): array

return array

RunConfiguration::setDownloadFileExt 

predicates

public | static

public static function setDownloadFileExt(
      Parameter #0 [ <required> array $download_file_ext ]
 ): void

param array $download_file_ext

return void

RunConfiguration::getShowDatestamp 

predicates

public | static

public static function getShowDatestamp(): bool

return bool

RunConfiguration::setShowDatestamp 

predicates

public | static

public static function setShowDatestamp(
      Parameter #0 [ <required> bool $show_datestamp ]
 ): void

param bool $show_datestamp

return void

RunConfiguration::get 

predicates	public
implements	ContainerInterface::get
inherited from	AbstractStaticContainer::get

@inheritdoc

Finds an entry of the container by its identifier and returns it

param string $id - Identifier of the entry to look for.
return mixed  - Entry.
throws NotFoundExceptionInterface  -  No entry was found for this identifier.
throws ContainerExceptionInterface  - Error while retrieving the entry.

@inheritdoc from method ContainerInterface::get

public function get(
      Parameter #0 [ <required> string $id ]
 ): mixed

param string $id

return mixed

RunConfiguration::has 

predicates	public
implements	ContainerInterface::has
inherited from	AbstractStaticContainer::has

@inheritdoc

Returns true if the container can return an entry for the given identifier

Returns false otherwise.

has($id) returning true does not mean that get($id) will not throw an exception. It does however mean that get($id) will not throw a NotFoundExceptionInterface.

param string $id - Identifier of the entry to look for.

return bool

@inheritdoc from method ContainerInterface::has

public function has(
      Parameter #0 [ <required> string $id ]
 ): bool

param string $id

return bool

RunConfiguration::__toString 

predicates	public
implements	Stringable::__toString
inherited from	AbstractStaticContainer::__toString

Returns a string representation of this container

public function __toString(): string

return string

RunConfiguration::load 

predicates	public \| static
inherited from	AbstractStaticContainer::load

Load the container with the given configuration

Keys in the array configuration should correspond to the names of cases in the UnitEnum given by AbstractStaticContainer::enumForName.

public static function load(
      Parameter #0 [ <required> array $configuration ]
 ): void

param array $configuration
return void
throws ContainerException  - if array in param $configuration not correct

RunConfiguration::toArray 

predicates	public \| static
inherited from	AbstractStaticContainer::toArray

Returns an array representing the container

public static function toArray(): array

return array - array representing the container

RunConfiguration::getMethodName 

predicates	public \| static
inherited from	AbstractStaticContainer::getMethodName

Return the method name part corresponding to the given param $id

Input of snake_like_name, output CamelCaseName:

foo_bar_name -> FooBarName

public static function getMethodName(
      Parameter #0 [ <required> string $id ]
 ): string

param string $id - snake_like_name

return string - CamelCaseName

Fri, 31 Mar 2023 13:22:46 +0000