MediaWiki master
MediaWiki\ResourceLoader\ForeignResourceManager Class Reference

Manage foreign resources registered with ResourceLoader. More...

Public Member Functions

 __construct ( $registryFile, $libDir, ?callable $infoPrinter=null, ?callable $errorPrinter=null, ?callable $verbosePrinter=null)
 
 generateCdx ()
 Returns a JSON string describing the foreign resources in a CycloneDX format.
 
 getCdxFileLocation ()
 Get the path to the CycloneDX file that describes the foreign resources.
 
 run ( $action, $module)
 

Detailed Description

Manage foreign resources registered with ResourceLoader.

Since
1.32
See also
https://www.mediawiki.org/wiki/Foreign_resources

Definition at line 42 of file ForeignResourceManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\ResourceLoader\ForeignResourceManager::__construct ( $registryFile,
$libDir,
?callable $infoPrinter = null,
?callable $errorPrinter = null,
?callable $verbosePrinter = null )
Parameters
string$registryFilePath to YAML file
string$libDirPath to a modules directory
callable | null$infoPrinterCallback for printing info about the run.
callable | null$errorPrinterCallback for printing errors from the run.
callable | null$verbosePrinterCallback for printing extra verbose progress information from the run.

Definition at line 94 of file ForeignResourceManager.php.

References MediaWiki\MainConfigNames\CacheDirectory, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ generateCdx()

MediaWiki\ResourceLoader\ForeignResourceManager::generateCdx ( )

Returns a JSON string describing the foreign resources in a CycloneDX format.

Definition at line 234 of file ForeignResourceManager.php.

◆ getCdxFileLocation()

MediaWiki\ResourceLoader\ForeignResourceManager::getCdxFileLocation ( )

Get the path to the CycloneDX file that describes the foreign resources.

Definition at line 245 of file ForeignResourceManager.php.

Referenced by MediaWiki\ResourceLoader\ForeignResourceManager\run().

◆ run()

MediaWiki\ResourceLoader\ForeignResourceManager::run ( $action,
$module )
Parameters
string$action
string$module
Returns
bool
Exceptions
LogicException

Definition at line 131 of file ForeignResourceManager.php.

References MediaWiki\ResourceLoader\ForeignResourceManager\getCdxFileLocation(), wfMkdirParents(), and wfRecursiveRemoveDir().


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