mwstake/mediawiki-component-dynamicfiledispatcher

Provides a new entrypoint to serve dynamically created files

1.0.1 2024-11-28 10:07 UTC

Requires

• composer/installers: ~1.0|~2
• mwstake/mediawiki-componentloader: ~1

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 39.0.0
• mediawiki/minus-x: 1.1.1
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.3.2
• phpunit/phpunit: ^8.5

GPL-3.0-only

• BlueSpice

README

Provides dynamic images from registered modeules.

Usage

Getting URL

/** @var DynamicFileDispatcherFactory $dynamicFileFactory */
$dynamicFileFactory = MediaWikiServices::getInstance()->getService(
    'MWStake.DynamicFileDispatcher.Factory'
);
// getUrl( string $moduleName, array $params )
$src = $dynamicFileFactory->getUrl( 'userprofileimage', $userImageParams );

Registering modules

Create a class implementing MWStake\MediaWiki\Component\DynamicFileDispatcher\IDynamicFileModule interface.

Register:

• using Global var
• using hook

// Using global var - OF spec
$mwsgMWStakeDynamicFileDispatcherModules['myModule'] = [
    'class' => 'MyModuleClass',
    'services' => [
       'A', 'B'
    ],
];

// Using hook
$wgHooks['MWStakeDynamicFileDispatcherRegisterModule'][] = function( &$modules ) {
    $modules['myModule'] = new MyModule();
};