includes/utils/RowUpdateGenerator.php

   1 <?php
   2 /**
   3  * Interface for generating updates to single rows in the database.
   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  * @stable to implement
  21  *
  22  * @file
  23  * @ingroup Maintenance
  24  */
  25 interface RowUpdateGenerator {
  26         /**
  27          * Given a database row, generates an array mapping column names to
  28          * updated value within the database row.
  29          *
  30          * Sample Response:
  31          *   return [
  32          *       'some_col' => 'new value',
  33          *       'other_col' => 99,
  34          *   ];
  35          *
  36          * @param stdClass $row A row from the database
  37          * @return array Map of column names to updated value within the
  38          *  database row. When no update is required returns an empty array.
  39          */
  40         public function update( $row );
  41 }