[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Interface used by archives that write to files.
  19   *
  20   * @package   core_files
  21   * @copyright 2020 Mark Nelson <mdjnelson@gmail.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_files\local\archive_writer;
  26  
  27  /**
  28   * Interface used by archives that write to files.
  29   *
  30   * @package   core_files
  31   * @copyright 2020 Mark Nelson <mdjnelson@gmail.com>
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  interface file_writer_interface {
  35  
  36      /**
  37       * Return the file instance.
  38       *
  39       * @param string $filename
  40       * @return static
  41       */
  42      public static function file_instance(string $filename): self;
  43  
  44      /**
  45       * Get the path of the zip.
  46       *
  47       * @return string
  48       */
  49      public function get_path_to_zip(): string;
  50  }