includes/page/RollbackPageFactory.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\Page;
  22
  23 use MediaWiki\Permissions\Authority;
  24 use MediaWiki\User\UserIdentity;
  25
  26 /**
  27  * Service for page rollback actions.
  28  *
  29  * Default implementation is MediaWiki\Page\PageCommandFactory.
  30  *
  31  * @since 1.37
  32  */
  33 interface RollbackPageFactory {
  34
  35         /**
  36          * Create a new command instance for page rollback.
  37          *
  38          * @param PageIdentity $page
  39          * @param Authority $performer
  40          * @param UserIdentity $byUser
  41          * @return RollbackPage
  42          */
  43         public function newRollbackPage(
  44                 PageIdentity $page,
  45                 Authority $performer,
  46                 UserIdentity $byUser
  47         ): RollbackPage;
  48 }