[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  namespace repository_googledocs\local\node;
  18  
  19  /**
  20   * The googledocs repository content node interface.
  21   *
  22   * @package    repository_googledocs
  23   * @copyright  2021 Mihail Geshoski <mihail@moodle.com>
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  interface node {
  27  
  28      /**
  29       * Create a repository node array.
  30       *
  31       * This method returns an array which structure is compatible to represent a content node (file/folder)
  32       * in the repository.
  33       *
  34       * @return array|null The node array or null if the node could not be created
  35       */
  36      public function create_node_array(): ?array;
  37  }