includes/collation/Hook/Collation__factoryHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 // phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
   6 use Collation;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "Collation::factory" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface Collation__factoryHook {
  16         /**
  17          * This hook is called if $wgCategoryCollation is an unknown collation.
  18          *
  19          * @since 1.35
  20          *
  21          * @param string $collationName Name of the collation in question
  22          * @param Collation|null &$collationObject Null. Replace with a subclass of
  23          *   the Collation class that implements the collation given in $collationName.
  24          * @return bool|void True or no return value to continue or false to abort
  25          */
  26         public function onCollation__factory( $collationName, &$collationObject );
  27 }