includes/filerepo/FileRepoStatus.php

   1 <?php
   2 /**
   3  * Generic operation result for FileRepo-related operations.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup FileRepo
  22  */
  23
  24 /**
  25  * Generic operation result class for FileRepo-related operations
  26  * @ingroup FileRepo
  27  */
  28 class FileRepoStatus extends Status {
  29         /**
  30          * Factory function for fatal errors
  31          *
  32          * @param FileRepo $repo
  33          * @return FileRepoStatus
  34          */
  35         static function newFatal( $repo /*, parameters...*/ ) {
  36                 $params = array_slice( func_get_args(), 1 );
  37                 $result = new self( $repo );
  38                 call_user_func_array( array( &$result, 'error' ), $params );
  39                 $result->ok = false;
  40
  41                 return $result;
  42         }
  43
  44         /**
  45          * @param FileRepo|bool $repo Default: false
  46          * @param mixed $value
  47          * @return FileRepoStatus
  48          */
  49         static function newGood( $repo = false, $value = null ) {
  50                 $result = new self( $repo );
  51                 $result->value = $value;
  52
  53                 return $result;
  54         }
  55
  56         /**
  57          * @param bool|FileRepo $repo
  58          */
  59         function __construct( $repo = false ) {
  60                 if ( $repo ) {
  61                         $this->cleanCallback = $repo->getErrorCleanupFunction();
  62                 }
  63         }
  64 }