http://www.mediawiki.org/wiki/Special:Code/MediaWiki/70157
Revision: 70157
Author: jeroendedauw
Date: 2010-07-29 18:36:39 +0000 (Thu, 29 Jul 2010)
Log Message:
-----------
Added deployment documentation group
Modified Paths:
--------------
trunk/phase3/includes/installer/CliInstaller.php
trunk/phase3/includes/installer/CoreInstaller.php
trunk/phase3/includes/installer/DatabaseInstaller.php
trunk/phase3/includes/installer/DatabaseUpdater.php
trunk/phase3/includes/installer/Installer.php
trunk/phase3/includes/installer/LocalSettingsGenerator.php
trunk/phase3/includes/installer/MysqlInstaller.php
trunk/phase3/includes/installer/MysqlUpdater.php
trunk/phase3/includes/installer/OracleInstaller.php
trunk/phase3/includes/installer/PostgresInstaller.php
trunk/phase3/includes/installer/SqliteInstaller.php
trunk/phase3/includes/installer/SqliteUpdater.php
trunk/phase3/includes/installer/WebInstaller.php
trunk/phase3/includes/installer/WebInstallerOutput.php
trunk/phase3/includes/installer/WebInstallerPage.php
Modified: trunk/phase3/includes/installer/CliInstaller.php
===================================================================
--- trunk/phase3/includes/installer/CliInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/CliInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -3,6 +3,7 @@
/**
* Class for the core installer command line interface.
*
+ * @ingroup Deployment
* @since 1.17
*/
class CliInstaller extends CoreInstaller {
Modified: trunk/phase3/includes/installer/CoreInstaller.php
===================================================================
--- trunk/phase3/includes/installer/CoreInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/CoreInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -4,6 +4,7 @@
* Base core installer class.
* Handles everything that is independent of user interface.
*
+ * @ingroup Deployment
* @since 1.17
*/
abstract class CoreInstaller extends Installer {
Modified: trunk/phase3/includes/installer/DatabaseInstaller.php
===================================================================
--- trunk/phase3/includes/installer/DatabaseInstaller.php 2010-07-29
18:35:26 UTC (rev 70156)
+++ trunk/phase3/includes/installer/DatabaseInstaller.php 2010-07-29
18:36:39 UTC (rev 70157)
@@ -2,6 +2,9 @@
/**
* Base class for DBMS-specific installation helper classes.
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
abstract class DatabaseInstaller {
Modified: trunk/phase3/includes/installer/DatabaseUpdater.php
===================================================================
--- trunk/phase3/includes/installer/DatabaseUpdater.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/DatabaseUpdater.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -3,6 +3,9 @@
/*
* Class for handling database updates. Roughly based off of updaters.inc, with
* a few improvements :)
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
abstract class DatabaseUpdater {
Modified: trunk/phase3/includes/installer/Installer.php
===================================================================
--- trunk/phase3/includes/installer/Installer.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/Installer.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,11 +1,18 @@
<?php
/**
+ * This documentation group collects source code files with deployment
functionality.
+ *
+ * @defgroup Deployment Deployment
+ */
+
+/**
* Base installer class.
*
* This class provides the base for installation and update functionality
* for both MediaWiki core and extensions.
*
+ * @ingroup Deployment
* @since 1.17
*/
abstract class Installer {
Modified: trunk/phase3/includes/installer/LocalSettingsGenerator.php
===================================================================
--- trunk/phase3/includes/installer/LocalSettingsGenerator.php 2010-07-29
18:35:26 UTC (rev 70156)
+++ trunk/phase3/includes/installer/LocalSettingsGenerator.php 2010-07-29
18:36:39 UTC (rev 70157)
@@ -1,5 +1,11 @@
<?php
+/**
+ * Class for manipulating LocalSettings.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class LocalSettingsGenerator {
private $extensions = array();
Modified: trunk/phase3/includes/installer/MysqlInstaller.php
===================================================================
--- trunk/phase3/includes/installer/MysqlInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/MysqlInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,5 +1,11 @@
<?php
+/**
+ * Class for setting up the MediaWiki database using MySQL.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class MysqlInstaller extends DatabaseInstaller {
protected $globalNames = array(
@@ -60,10 +66,10 @@
}
public function submitConnectForm() {
- // Get variables from the request
+ // Get variables from the request.
$newValues = $this->setVarsFromRequest( array( 'wgDBserver',
'wgDBname', 'wgDBprefix' ) );
- // Validate them
+ // Validate them.
$status = Status::newGood();
if ( !strlen( $newValues['wgDBname'] ) ) {
$status->fatal( 'config-missing-db-name' );
Modified: trunk/phase3/includes/installer/MysqlUpdater.php
===================================================================
--- trunk/phase3/includes/installer/MysqlUpdater.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/MysqlUpdater.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,9 +1,13 @@
<?php
/**
- * Mysql update list and mysql-specific update functions
+ * Mysql update list and mysql-specific update functions.
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
class MysqlUpdater extends DatabaseUpdater {
+
protected function getCoreUpdateList() {
return array(
'1.2' => array(
Modified: trunk/phase3/includes/installer/OracleInstaller.php
===================================================================
--- trunk/phase3/includes/installer/OracleInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/OracleInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,5 +1,11 @@
<?php
+/**
+ * Class for setting up the MediaWiki database using Oracle.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class OracleInstaller extends DatabaseInstaller {
protected $globalNames = array(
Modified: trunk/phase3/includes/installer/PostgresInstaller.php
===================================================================
--- trunk/phase3/includes/installer/PostgresInstaller.php 2010-07-29
18:35:26 UTC (rev 70156)
+++ trunk/phase3/includes/installer/PostgresInstaller.php 2010-07-29
18:36:39 UTC (rev 70157)
@@ -1,5 +1,11 @@
<?php
+/**
+ * Class for setting up the MediaWiki database using Postgres.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class PostgresInstaller extends DatabaseInstaller {
protected $globalNames = array(
Modified: trunk/phase3/includes/installer/SqliteInstaller.php
===================================================================
--- trunk/phase3/includes/installer/SqliteInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/SqliteInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,5 +1,11 @@
<?php
+/**
+ * Class for setting up the MediaWiki database using SQLLite.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
class SqliteInstaller extends DatabaseInstaller {
protected $globalNames = array(
Modified: trunk/phase3/includes/installer/SqliteUpdater.php
===================================================================
--- trunk/phase3/includes/installer/SqliteUpdater.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/SqliteUpdater.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -1,8 +1,13 @@
<?php
+
/**
- * Sqlite
+ * Class for handling updates to Sqlite databases.
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
class SqliteUpdater extends DatabaseUpdater {
+
protected function getCoreUpdateList() {
return array(
'1.14' => array(
Modified: trunk/phase3/includes/installer/WebInstaller.php
===================================================================
--- trunk/phase3/includes/installer/WebInstaller.php 2010-07-29 18:35:26 UTC
(rev 70156)
+++ trunk/phase3/includes/installer/WebInstaller.php 2010-07-29 18:36:39 UTC
(rev 70157)
@@ -3,6 +3,7 @@
/**
* Class for the core installer web interface.
*
+ * @ingroup Deployment
* @since 1.17
*/
class WebInstaller extends CoreInstaller {
Modified: trunk/phase3/includes/installer/WebInstallerOutput.php
===================================================================
--- trunk/phase3/includes/installer/WebInstallerOutput.php 2010-07-29
18:35:26 UTC (rev 70156)
+++ trunk/phase3/includes/installer/WebInstallerOutput.php 2010-07-29
18:36:39 UTC (rev 70157)
@@ -7,6 +7,9 @@
* the interests of separation of concerns: if we used a subclass, there would
be
* quite a lot of things you could do in OutputPage that would break the
installer,
* that wouldn't be immediately obvious.
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
class WebInstallerOutput {
Modified: trunk/phase3/includes/installer/WebInstallerPage.php
===================================================================
--- trunk/phase3/includes/installer/WebInstallerPage.php 2010-07-29
18:35:26 UTC (rev 70156)
+++ trunk/phase3/includes/installer/WebInstallerPage.php 2010-07-29
18:36:39 UTC (rev 70157)
@@ -2,6 +2,9 @@
/**
* Abstract class to define pages for the web installer.
+ *
+ * @ingroup Deployment
+ * @since 1.17
*/
abstract class WebInstallerPage {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
