ApiQueryGadgetCategories.php

Go to the documentation of this file.

<?php
class ApiQueryGadgetCategories extends ApiQueryBase {
    private $props;
 
    private $neededNames;
 
    public function __construct( ApiQuery $queryModule, $moduleName ) {
        parent::__construct( $queryModule, $moduleName, 'gc' );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
        $this->props = array_flip( $params['prop'] );
        $this->neededNames = isset( $params['names'] )
            ? array_flip( $params['names'] )
            : false;
 
        $this->getMain()->setCacheMode( 'public' );
 
        $this->getList();
    }
 
    private function getList() {
        $data = [];
        $result = $this->getResult();
        $gadgets = GadgetRepo::singleton()->getStructuredList();
 
        if ( $gadgets ) {
            foreach ( $gadgets as $category => $list ) {
                if ( !$this->neededNames || isset( $this->neededNames[$category] ) ) {
                    $row = [];
                    if ( isset( $this->props['name'] ) ) {
                        $row['name'] = $category;
                    }
 
                    if ( $category !== "" ) {
                        if ( isset( $this->props['title'] ) ) {
                            $row['desc'] = $this->msg( "gadget-section-$category" )->parse();
                        }
                    }
 
                    if ( isset( $this->props['members'] ) ) {
                        $row['members'] = count( $list );
                    }
 
                    $data[] = $row;
                }
            }
        }
        $result->setIndexedTagName( $data, 'category' );
        $result->addValue( 'query', $this->getModuleName(), $data );
    }
 
    public function getAllowedParams() {
        return [
            'prop' => [
                ApiBase::PARAM_DFLT => 'name',
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => [
                    'name',
                    'title',
                    'members',
                ],
            ],
            'names' => [
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&list=gadgetcategories'
                => 'apihelp-query+gadgetcategories-example-1',
            'action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members'
                => 'apihelp-query+gadgetcategories-example-2',
        ];
    }
}