MediaWiki  master
MediaWiki\Collation\CollationFactory Class Reference

Common factory to construct collation classes. More...

Collaboration diagram for MediaWiki\Collation\CollationFactory:

Public Member Functions

 __construct (ServiceOptions $options, ObjectFactory $objectFactory, HookContainer $hookContainer)
 
 getCategoryCollation ()
 
 makeCollation (string $collationName)
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Private Member Functions

 instantiateCollation ( $spec)
 

Private Attributes

HookRunner $hookRunner
 
ObjectFactory $objectFactory
 
ServiceOptions $options
 
const CORE_COLLATIONS
 

Detailed Description

Common factory to construct collation classes.

Since
1.37

Definition at line 36 of file CollationFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Collation\CollationFactory::__construct ( ServiceOptions  $options,
ObjectFactory  $objectFactory,
HookContainer  $hookContainer 
)
Parameters
ServiceOptions$options
ObjectFactory$objectFactory
HookContainer$hookContainer

Definition at line 116 of file CollationFactory.php.

References MediaWiki\Collation\CollationFactory\$objectFactory, MediaWiki\Collation\CollationFactory\$options, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getCategoryCollation()

MediaWiki\Collation\CollationFactory::getCategoryCollation ( )

◆ instantiateCollation()

MediaWiki\Collation\CollationFactory::instantiateCollation (   $spec)
private
Parameters
array$spec
Returns
Collation

Definition at line 171 of file CollationFactory.php.

Referenced by MediaWiki\Collation\CollationFactory\makeCollation().

◆ makeCollation()

MediaWiki\Collation\CollationFactory::makeCollation ( string  $collationName)
Exceptions
MWException
Parameters
string$collationName
Returns
Collation

Definition at line 139 of file CollationFactory.php.

References MediaWiki\Collation\CollationFactory\instantiateCollation().

Referenced by MediaWiki\Collation\CollationFactory\getCategoryCollation().

Member Data Documentation

◆ $hookRunner

HookRunner MediaWiki\Collation\CollationFactory::$hookRunner
private

Definition at line 109 of file CollationFactory.php.

◆ $objectFactory

ObjectFactory MediaWiki\Collation\CollationFactory::$objectFactory
private

◆ $options

ServiceOptions MediaWiki\Collation\CollationFactory::$options
private

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Collation\CollationFactory::CONSTRUCTOR_OPTIONS
Initial value:
= [
'CategoryCollation',
]
Access: internal
For use by ServiceWiring

Definition at line 40 of file CollationFactory.php.

◆ CORE_COLLATIONS

const MediaWiki\Collation\CollationFactory::CORE_COLLATIONS
private

Definition at line 44 of file CollationFactory.php.


The documentation for this class was generated from the following file: