ModuleMode.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Module;
 
enum ModuleMode: string {
    case DISABLED = 'disabled';         // treated as if the module does not exist
    case HIDDEN = 'hidden';             // callable, excluded from /discovery and the REST Sandbox
    case DISCOVERABLE = 'discoverable'; // callable, listed in /discovery, excluded from the REST Sandbox
    case PUBLISHED = 'published';       // callable, listed in /discovery and the REST Sandbox
 
    public static function getModuleMode( ?AudienceDesignation $ad ): ModuleMode {
        if ( $ad === null ) {
            return self::DISABLED;
        }
 
        return match ( $ad ) {
            AudienceDesignation::PUBLIC => self::PUBLISHED,
            AudienceDesignation::INTERNAL => self::PUBLISHED,
            AudienceDesignation::BETA => self::PUBLISHED
        };
    }
 
    public static function getModeParams( ?AudienceDesignation $ad ): array {
        $params = [];
 
        if ( $ad === AudienceDesignation::BETA ) {
            $params['group'] = 'beta';
        }
        if ( $ad === AudienceDesignation::INTERNAL ) {
            $params['group'] = 'internal';
        }
 
        return $params;
    }
}