summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/Translate/api/ApiAggregateGroups.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/Translate/api/ApiAggregateGroups.php')
-rw-r--r--www/wiki/extensions/Translate/api/ApiAggregateGroups.php86
1 files changed, 44 insertions, 42 deletions
diff --git a/www/wiki/extensions/Translate/api/ApiAggregateGroups.php b/www/wiki/extensions/Translate/api/ApiAggregateGroups.php
index b54e4385..a8a259df 100644
--- a/www/wiki/extensions/Translate/api/ApiAggregateGroups.php
+++ b/www/wiki/extensions/Translate/api/ApiAggregateGroups.php
@@ -5,7 +5,7 @@
* @author Santhosh Thottingal
* @author Niklas Laxström
* @copyright Copyright © 2012-2013, Santhosh Thottingal
- * @license GPL-2.0+
+ * @license GPL-2.0-or-later
*/
/**
@@ -19,30 +19,28 @@ class ApiAggregateGroups extends ApiBase {
protected static $right = 'translate-manage';
public function execute() {
- if ( !$this->getUser()->isAllowed( self::$right ) ) {
- $this->dieUsage( 'Permission denied', 'permissiondenied' );
- }
+ $this->checkUserRightsAny( self::$right );
$params = $this->extractRequestParams();
$action = $params['do'];
- $output = array();
+ $output = [];
if ( $action === 'associate' || $action === 'dissociate' ) {
// Group is mandatory only for these two actions
if ( !isset( $params['group'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'group' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'group' ] );
}
if ( !isset( $params['aggregategroup'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'aggregategroup' ] );
}
$aggregateGroup = $params['aggregategroup'];
$subgroups = TranslateMetadata::getSubgroups( $aggregateGroup );
- if ( count( $subgroups ) === 0 ) {
+ if ( !$subgroups ) {
// For newly created groups the subgroups value might be empty,
// but check that.
if ( TranslateMetadata::get( $aggregateGroup, 'name' ) === false ) {
- $this->dieUsage( 'Invalid aggregate message group', 'invalidaggregategroup' );
+ $this->dieWithError( 'apierror-translate-invalidaggregategroup', 'invalidaggregategroup' );
}
- $subgroups = array();
+ $subgroups = [];
}
$subgroupId = $params['group'];
@@ -51,7 +49,7 @@ class ApiAggregateGroups extends ApiBase {
// Add or remove from the list
if ( $action === 'associate' ) {
if ( !$group instanceof WikiPageMessageGroup ) {
- $this->dieUsage( 'Group does not exist or invalid', 'invalidgroup' );
+ $this->dieWithError( 'apierror-translate-invalidgroup', 'invalidgroup' );
}
$subgroups[] = $subgroupId;
@@ -65,10 +63,10 @@ class ApiAggregateGroups extends ApiBase {
TranslateMetadata::setSubgroups( $aggregateGroup, $subgroups );
- $logParams = array(
+ $logParams = [
'aggregategroup' => TranslateMetadata::get( $aggregateGroup, 'name' ),
'aggregategroup-id' => $aggregateGroup,
- );
+ ];
/* Note that to allow removing no longer existing groups from
* aggregate message groups, the message group object $group
@@ -89,22 +87,24 @@ class ApiAggregateGroups extends ApiBase {
$entry->publish( $logid );
} elseif ( $action === 'remove' ) {
if ( !isset( $params['aggregategroup'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'aggregategroup' ] );
}
TranslateMetadata::deleteGroup( $params['aggregategroup'] );
// @todo Logging
} elseif ( $action === 'add' ) {
if ( !isset( $params['groupname'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'groupname' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'groupname' ] );
}
$name = trim( $params['groupname'] );
if ( strlen( $name ) === 0 ) {
- $this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' );
+ $this->dieWithError(
+ 'apierror-translate-invalidaggregategroupname', 'invalidaggregategroupname'
+ );
}
if ( !isset( $params['groupdescription'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'groupdescription' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'groupdescription' ] );
}
$desc = trim( $params['groupdescription'] );
@@ -113,7 +113,7 @@ class ApiAggregateGroups extends ApiBase {
// Throw error if group already exists
$nameExists = MessageGroups::labelExists( $name );
if ( $nameExists ) {
- $this->dieUsage( 'Message group already exists', 'duplicateaggregategroup' );
+ $this->dieWithError( 'apierror-translate-duplicateaggregategroup', 'duplicateaggregategroup' );
}
// ID already exists- Generate a new ID by adding a number to it.
@@ -130,7 +130,7 @@ class ApiAggregateGroups extends ApiBase {
TranslateMetadata::set( $aggregateGroupId, 'name', $name );
TranslateMetadata::set( $aggregateGroupId, 'description', $desc );
- TranslateMetadata::setSubgroups( $aggregateGroupId, array() );
+ TranslateMetadata::setSubgroups( $aggregateGroupId, [] );
// Once new aggregate group added, we need to show all the pages that can be added to that.
$output['groups'] = self::getAllPages();
@@ -138,11 +138,13 @@ class ApiAggregateGroups extends ApiBase {
// @todo Logging
} elseif ( $action === 'update' ) {
if ( !isset( $params['groupname'] ) ) {
- $this->dieUsageMsg( array( 'missingparam', 'groupname' ) );
+ $this->dieWithError( [ 'apierror-missingparam', 'groupname' ] );
}
$name = trim( $params['groupname'] );
if ( strlen( $name ) === 0 ) {
- $this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' );
+ $this->dieWithError(
+ 'apierror-translate-invalidaggregategroupname', 'invalidaggregategroupname'
+ );
}
$desc = trim( $params['groupdescription'] );
$aggregateGroupId = $params['aggregategroup'];
@@ -153,11 +155,11 @@ class ApiAggregateGroups extends ApiBase {
// Error if the label exists already
$exists = MessageGroups::labelExists( $name );
if ( $exists && $oldName !== $name ) {
- $this->dieUsage( 'Message group name already exists', 'duplicateaggregategroup' );
+ $this->dieWithError( 'apierror-translate-duplicateaggregategroup', 'duplicateaggregategroup' );
}
if ( $oldName === $name && $oldDesc === $desc ) {
- $this->dieUsage( 'Invalid update', 'invalidupdate' );
+ $this->dieWithError( 'apierror-translate-invalidupdate', 'invalidupdate' );
}
TranslateMetadata::set( $aggregateGroupId, 'name', $name );
TranslateMetadata::set( $aggregateGroupId, 'description', $desc );
@@ -168,7 +170,7 @@ class ApiAggregateGroups extends ApiBase {
$this->getResult()->addValue( null, $this->getModuleName(), $output );
// Cache needs to be cleared after any changes to groups
MessageGroups::singleton()->recache();
- MessageIndexRebuildJob::newJob()->insert();
+ MessageIndexRebuildJob::newJob()->insertIntoJobQueue();
}
protected function generateAggregateGroupId( $aggregateGroupName, $prefix = 'agg-' ) {
@@ -190,41 +192,41 @@ class ApiAggregateGroups extends ApiBase {
}
public function getAllowedParams() {
- return array(
- 'do' => array(
- ApiBase::PARAM_TYPE => array( 'associate', 'dissociate', 'remove', 'add', 'update' ),
+ return [
+ 'do' => [
+ ApiBase::PARAM_TYPE => [ 'associate', 'dissociate', 'remove', 'add', 'update' ],
ApiBase::PARAM_REQUIRED => true,
- ),
- 'aggregategroup' => array(
+ ],
+ 'aggregategroup' => [
ApiBase::PARAM_TYPE => 'string',
- ),
- 'group' => array(
+ ],
+ 'group' => [
// Not providing list of values, to allow dissociation of unknown groups
ApiBase::PARAM_TYPE => 'string',
- ),
- 'groupname' => array(
+ ],
+ 'groupname' => [
ApiBase::PARAM_TYPE => 'string',
- ),
- 'groupdescription' => array(
+ ],
+ 'groupdescription' => [
ApiBase::PARAM_TYPE => 'string',
- ),
- 'token' => array(
+ ],
+ 'token' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
- ),
- );
+ ],
+ ];
}
protected function getExamplesMessages() {
- return array(
+ return [
'action=aggregategroups&do=associate&group=groupId&aggregategroup=aggregateGroupId'
=> 'apihelp-aggregategroups-example-1',
- );
+ ];
}
public static function getAllPages() {
$groups = MessageGroups::getAllGroups();
- $pages = array();
+ $pages = [];
foreach ( $groups as $group ) {
if ( $group instanceof WikiPageMessageGroup ) {
$pages[$group->getId()] = $group->getTitle()->getPrefixedText();
generated by cgit v1.2.1 (git 2.18.0) at 2024-04-30 01:27:41 +0000