Ragesoss has uploaded a new change for review.
https://gerrit.wikimedia.org/r/95158
Change subject: Switch long comments to into PHPDoc format
......................................................................
Switch long comments to into PHPDoc format
Change-Id: If6a1c4bf69cf43e04b802ebe077d2ace39183f5c
---
M EducationProgram.php
1 file changed, 79 insertions(+), 23 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/EducationProgram
refs/changes/58/95158/1
diff --git a/EducationProgram.php b/EducationProgram.php
index 2dc3402..a9baf62 100644
--- a/EducationProgram.php
+++ b/EducationProgram.php
@@ -55,17 +55,29 @@
'descriptionmsg' => 'educationprogram-desc'
);
-// i18n: This tells MediaWiki where to look for all the message strings for
the extension, which are kept in the standard i18n files.
+/**
+ * i18n: This tells MediaWiki where to look for all the message strings for
the extension,
+ * which are kept in the standard i18n files.
+ */
$dir = __DIR__;
$wgExtensionMessagesFiles['EducationProgram'] = $dir .
'/EducationProgram.i18n.php';
$wgExtensionMessagesFiles['EducationProgramAlias'] = $dir .
'/EducationProgram.i18n.alias.php';
$wgExtensionMessagesFiles['EPNamespaces'] = $dir .
'/EducationProgram.i18n.ns.php';
-// Autoloading: This tells MediaWiki where to look for the hooks that get
loaded to integrate the features of the extension into the rest of the wiki,
such as new entries in Special:MyPreferences
+/**
+ * Autoloading
+ *
+ * This tells MediaWiki where to look for the hooks that get loaded to
integrate
+ * the features of the extension into the rest of the wiki, such as new
entries in Special:MyPreferences
+ */
$wgAutoloadClasses['EducationProgram\Hooks']
= $dir . '/EducationProgram.hooks.php';
-// includes/actions (deriving from Action)
-// These tell Mediawiki where to look for the new actions used by the
extension for interacting with course pages and the like.
+/**
+ * includes/actions (deriving from Action)
+ *
+ * These tell Mediawiki where to look for the new actions used by the
extension for
+ * interacting with course pages and the like.
+ */
$wgAutoloadClasses['EducationProgram\EditCourseAction']
= $dir . '/includes/actions/EditCourseAction.php';
$wgAutoloadClasses['EducationProgram\EditOrgAction']
= $dir . '/includes/actions/EditOrgAction.php';
$wgAutoloadClasses['EducationProgram\Action']
= $dir . '/includes/actions/Action.php';
@@ -85,8 +97,11 @@
$wgAutoloadClasses['EducationProgram\ViewCourseActivityAction'] = $dir
. '/includes/actions/ViewCourseActivityAction.php';
$wgAutoloadClasses['EducationProgram\ViewOrgAction']
= $dir . '/includes/actions/ViewOrgAction.php';
-// includes/api (deriving from ApiBase)
-// Many of the actions can also be performed through the API.
+/**
+ * includes/api (deriving from ApiBase)
+ *
+ * Many of the actions can also be performed through the API.
+ */
$wgAutoloadClasses['EducationProgram\ApiDeleteEducation']
= $dir . '/includes/api/ApiDeleteEducation.php';
$wgAutoloadClasses['EducationProgram\ApiEnlist']
= $dir . '/includes/api/ApiEnlist.php';
$wgAutoloadClasses['EducationProgram\ApiRefreshEducation']
= $dir . '/includes/api/ApiRefreshEducation.php';
@@ -103,8 +118,13 @@
$wgAutoloadClasses['EducationProgram\Store\CourseStore']
= $dir . '/includes/Store/CourseStore.php';
-// includes/pagers (implementing Pager)
-// These are the Pager classes, which are used for displaying page-by-page
results of long lists of info related to the extension, such as the tables of
students and their articles on course pages.
+/**
+ * includes/pagers (implementing Pager)
+ *
+ * These are the Pager classes, which are used for displaying page-by-page
results
+ * of long lists of info related to the extension, such as the tables of
students
+ * and their articles on course pages.
+ */
$wgAutoloadClasses['EducationProgram\ArticleTable']
= $dir . '/includes/pagers/ArticleTable.php';
$wgAutoloadClasses['EducationProgram\CAPager']
= $dir . '/includes/pagers/CAPager.php';
$wgAutoloadClasses['EducationProgram\CoursePager']
= $dir . '/includes/pagers/CoursePager.php';
@@ -115,8 +135,13 @@
$wgAutoloadClasses['EducationProgram\StudentPager']
= $dir . '/includes/pagers/StudentPager.php';
$wgAutoloadClasses['EducationProgram\StudentActivityPager'] = $dir
. '/includes/pagers/StudentActivityPager.php';
-// includes/pages (here core is a mess :)
-// The extension introduces a class of article-like pages, EducationPage.
There are two specific types: CoursePage, for course pages, and OrgPage, for
organization pages.
+/**
+ * includes/pages (here core is a mess :)
+ *
+ * The extension introduces a class of article-like pages, EducationPage.
+ * There are two specific types:
+ * CoursePage, for course pages, and OrgPage, for organization pages.
+ */
$wgAutoloadClasses['EducationProgram\CoursePage']
= $dir . '/includes/pages/CoursePage.php';
$wgAutoloadClasses['EducationProgram\EducationPage']
= $dir . '/includes/pages/EducationPage.php';
$wgAutoloadClasses['EducationProgram\OrgPage']
= $dir . '/includes/pages/OrgPage.php';
@@ -133,8 +158,13 @@
$wgAutoloadClasses['EducationProgram\RevisionedObject']
= $dir . '/includes/rows/RevisionedObject.php';
$wgAutoloadClasses['EducationProgram\Student']
= $dir . '/includes/rows/Student.php';
-// includes/specials (deriving from SpecialPage)
-// These are the special pages created by the extension, some of which may be
disable for performance reasons. VerySpecialPage is a base class with common
functions used by many of the individual special pages.
+/**
+ * includes/specials (deriving from SpecialPage)
+ *
+ * These are the special pages created by the extension, some of which may be
disabled
+ * for performance reasons. VerySpecialPage is a base class with common
functions
+ * used by many of the individual special pages.
+ */
$wgAutoloadClasses['EducationProgram\SpecialAmbassadorProfile'] = $dir
. '/includes/specials/SpecialAmbassadorProfile.php';
$wgAutoloadClasses['EducationProgram\SpecialCAProfile']
= $dir . '/includes/specials/SpecialCAProfile.php';
$wgAutoloadClasses['EducationProgram\SpecialCAs']
= $dir . '/includes/specials/SpecialCAs.php';
@@ -153,8 +183,12 @@
$wgAutoloadClasses['EducationProgram\SpecialStudents']
= $dir . '/includes/specials/SpecialStudents.php';
$wgAutoloadClasses['EducationProgram\VerySpecialPage']
= $dir . '/includes/specials/VerySpecialPage.php';
-// includes/tables (deriving from ORMTable)
-// These classes correspond to the database tables associated with this
extension, and provide functions for interacting with the data in these tables.
+/**
+ * includes/tables (deriving from ORMTable)
+ *
+ * These classes correspond to the database tables associated with this
extension,
+ * and provide functions for interacting with the data in these tables.
+ */
$wgAutoloadClasses['EducationProgram\CAs']
= $dir . '/includes/tables/CAs.php';
$wgAutoloadClasses['EducationProgram\Courses']
= $dir . '/includes/tables/Courses.php';
$wgAutoloadClasses['EducationProgram\Events']
= $dir . '/includes/tables/Events.php';
@@ -165,8 +199,11 @@
$wgAutoloadClasses['EducationProgram\Revisions']
= $dir . '/includes/tables/Revisions.php';
$wgAutoloadClasses['EducationProgram\Students']
= $dir . '/includes/tables/Students.php';
-// includes
-// These are other miscellaneous classes used by the extension and their
corresponding PHP files.
+/**
+ * includes
+ *
+ * These are other miscellaneous classes used by the extension and their
corresponding PHP files.
+ */
$wgAutoloadClasses['EducationProgram\ArticleAdder']
= $dir . '/includes/ArticleAdder.php';
$wgAutoloadClasses['EducationProgram\ArticleStore']
= $dir . '/includes/ArticleStore.php';
$wgAutoloadClasses['EducationProgram\CourseActivityView']
= $dir . '/includes/CourseActivityView.php';
@@ -194,8 +231,13 @@
$wgAutoloadClasses['EducationProgram\Tests\MockSuperUser']
= $dir . '/tests/phpunit/MockSuperUser.php';
$wgAutoloadClasses['EducationProgram\Tests\UserCourseFinderTest'] = $dir
. '/tests/phpunit/UserCourseFinderTest.php';
-// Special pages
-// These are the Special pages that are part of the extension. The default
name and url for some of these is different, as set by
EducationProgram.i18n.alias.php, but these are the names used within the rest
of the extension code.
+/**
+ *Special pages
+ *
+ * These are the Special pages that are part of the extension. The default
name and url
+ * for some of these is different, as set by EducationProgram.i18n.alias.php,
but
+ * these are the names used within the rest of the extension code.
+ */
$wgSpecialPages['CampusAmbassadorProfile'] =
'EducationProgram\SpecialCAProfile';
$wgSpecialPages['CampusAmbassadors'] =
'EducationProgram\SpecialCAs';
$wgSpecialPages['CourseActivity'] =
'EducationProgram\SpecialCourseActivity';
@@ -308,9 +350,13 @@
$wgAvailableRights[] = 'ep-remarticle'; // Remove a student's
associated article(s)
$wgAvailableRights[] = 'ep-addstudent'; // Enroll users as
student
-
-// User group rights
-// These set the defaults for which users can perform which actions, beginning
with the '*' defaults that apply to all users unless specifically set in a
subsequent block of permissions. These can be overridden locally if a wiki
wishes to use a different permissions setup.
+/**
+ * User group rights
+ *
+ * These set the defaults for which users can perform which actions, beginning
with the '*' defaults
+ * that apply to all users unless specifically set in a subsequent block of
permissions.
+ * These can be overridden locally if a wiki wishes to use a different
permissions setup.
+ */
$wgGroupPermissions['*']['ep-enroll'] = true;
$wgGroupPermissions['*']['ep-org'] = false;
$wgGroupPermissions['*']['ep-course'] = false;
@@ -383,7 +429,10 @@
$wgGroupPermissions['epcoordinator']['userrights'] = false;
-// These permissions let those with the epcoordinator (Course coordinator)
user right to assign the other extension rights to other users.
+/**
+ * These permissions let those with the epcoordinator (Course coordinator)
user right
+ * assign the other extension rights to other users.
+ */
$wgAddGroups['epcoordinator'] = array( 'eponline', 'epcampus', 'epinstructor'
);
$wgRemoveGroups['epcoordinator'] = array( 'eponline', 'epcampus',
'epinstructor' );
@@ -732,4 +781,11 @@
$wgDefaultUserOptions['ep_showtoplink'] = false;
$wgDefaultUserOptions['ep_bulkdelorgs'] = false;
$wgDefaultUserOptions['ep_bulkdelcourses'] = true;
-$wgDefaultUserOptions['ep_showdyk'] = true; // This enables the "Did You
Know" boxes that appear on course activities feeds. See the eponymous
extension, which was folded into this one:
https://www.mediawiki.org/wiki/Extension:Did_You_Know
+
+/**
+ * DYK box option
+ *
+ * This enables the "Did You Know" boxes that appear on course activities
feeds.
+ * See the eponymous extension, which was folded into this one:
https://www.mediawiki.org/wiki/Extension:Did_You_Know
+ */
+$wgDefaultUserOptions['ep_showdyk'] = true;
--
To view, visit https://gerrit.wikimedia.org/r/95158
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: If6a1c4bf69cf43e04b802ebe077d2ace39183f5c
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/EducationProgram
Gerrit-Branch: master
Gerrit-Owner: Ragesoss <rages...@gmail.com>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
