includes/services/DestructibleService.php

   1 <?php
   2 namespace MediaWiki\Services;
   3
   4 /**
   5  * Interface for destructible services.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  *
  24  * @since 1.27
  25  */
  26
  27 /**
  28  * DestructibleService defines a standard interface for shutting down a service instance.
  29  * The intended use is for a service container to be able to shut down services that should
  30  * no longer be used, and allow such services to release any system resources.
  31  *
  32  * @note There is no expectation that services will be destroyed when the process (or web request)
  33  * terminates.
  34  */
  35 interface DestructibleService {
  36
  37         /**
  38          * Notifies the service object that it should expect to no longer be used, and should release
  39          * any system resources it may own. The behavior of all service methods becomes undefined after
  40          * destroy() has been called. It is recommended that implementing classes should throw an
  41          * exception when service methods are accessed after destroy() has been called.
  42          */
  43         public function destroy();
  44
  45 }