Gadget.php

Go to the documentation of this file.

<?php
class Gadget {
    const GADGET_CLASS_VERSION = 9;
 
    const CACHE_TTL = 86400;
 
    private $scripts = [],
            $styles = [],
            $dependencies = [],
            $peers = [],
            $messages = [],
            $name,
            $definition,
            $resourceLoaded = false,
            $requiredRights = [],
            $requiredSkins = [],
            $targets = [ 'desktop' ],
            $onByDefault = false,
            $hidden = false,
            $type = '',
            $category;
 
    public function __construct( array $options ) {
        foreach ( $options as $member => $option ) {
            switch ( $member ) {
                case 'scripts':
                case 'styles':
                case 'dependencies':
                case 'peers':
                case 'messages':
                case 'name':
                case 'definition':
                case 'resourceLoaded':
                case 'requiredRights':
                case 'requiredSkins':
                case 'targets':
                case 'onByDefault':
                case 'type':
                case 'hidden':
                case 'category':
                    $this->{$member} = $option;
                    break;
                default:
                    throw new InvalidArgumentException( "Unrecognized '$member' parameter" );
            }
        }
    }
 
    public static function newFromDefinitionContent( $id, GadgetDefinitionContent $content ) {
        $data = $content->getAssocArray();
        $prefixGadgetNs = function ( $page ) {
            return 'Gadget:' . $page;
        };
        $info = [
            'name' => $id,
            'resourceLoaded' => true,
            'requiredRights' => $data['settings']['rights'],
            'onByDefault' => $data['settings']['default'],
            'hidden' => $data['settings']['hidden'],
            'requiredSkins' => $data['settings']['skins'],
            'category' => $data['settings']['category'],
            'scripts' => array_map( $prefixGadgetNs, $data['module']['scripts'] ),
            'styles' => array_map( $prefixGadgetNs, $data['module']['styles'] ),
            'dependencies' => $data['module']['dependencies'],
            'peers' => $data['module']['peers'],
            'messages' => $data['module']['messages'],
            'type' => $data['module']['type'],
        ];
 
        return new self( $info );
    }
 
    public static function newEmptyGadget( $id ) {
        return new self( [ 'name' => $id ] );
    }
 
    public static function isValidGadgetID( $id ) {
        return strlen( $id ) > 0 && ResourceLoader::isValidModuleName( self::getModuleName( $id ) );
    }
 
    public function getName() {
        return $this->name;
    }
 
    public function getDescription() {
        return wfMessage( "gadget-{$this->getName()}" )->parse();
    }
 
    public function getRawDescription() {
        return wfMessage( "gadget-{$this->getName()}" )->plain();
    }
 
    public function getCategory() {
        return $this->category;
    }
 
    public static function getModuleName( $id ) {
        return "ext.gadget.{$id}";
    }
 
    public function isEnabled( $user ) {
        return (bool)$user->getOption( "gadget-{$this->name}", $this->onByDefault );
    }
 
    public function isAllowed( User $user ) {
        return $user->isAllowedAll( ...$this->requiredRights );
    }
 
    public function isOnByDefault() {
        return $this->onByDefault;
    }
 
    public function isHidden() {
        return $this->hidden;
    }
 
    public function isSkinSupported( Skin $skin ) {
        return ( count( $this->requiredSkins ) === 0
                || in_array( $skin->getSkinName(), $this->requiredSkins )
            );
    }
 
    public function supportsResourceLoader() {
        return $this->resourceLoaded;
    }
 
    public function hasModule() {
        return count( $this->styles )
            + ( $this->supportsResourceLoader() ? count( $this->scripts ) : 0 )
                > 0;
    }
 
    public function getDefinition() {
        return $this->definition;
    }
 
    public function getScripts() {
        return $this->scripts;
    }
 
    public function getStyles() {
        return $this->styles;
    }
 
    public function getScriptsAndStyles() {
        return array_merge( $this->scripts, $this->styles );
    }
 
    public function getTargets() {
        return $this->targets;
    }
 
    public function getLegacyScripts() {
        if ( $this->supportsResourceLoader() ) {
            return [];
        }
        return $this->scripts;
    }
 
    public function getDependencies() {
        return $this->dependencies;
    }
 
    public function getPeers() {
        return $this->peers;
    }
 
    public function getMessages() {
        return $this->messages;
    }
 
    public function getRequiredRights() {
        return $this->requiredRights;
    }
 
    public function getRequiredSkins() {
        return $this->requiredSkins;
    }
 
    public function getType() {
        if ( $this->type === 'styles' || $this->type === 'general' ) {
            return $this->type;
        }
        // Similar to ResourceLoaderWikiModule default
        if ( $this->styles && !$this->scripts && !$this->dependencies ) {
            return 'styles';
        } else {
            return 'general';
        }
    }
}