[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   * Grade item, fieldname mapping.
  19   *
  20   * @package   core_grades
  21   * @copyright Ilya Tregubov <ilya.a.tregubov@gmail.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  declare(strict_types = 1);
  26  
  27  namespace core_grades\local\gradeitem;
  28  
  29  /**
  30   * Grade item, fieldname mapping.
  31   *
  32   * @package   core_grades
  33   * @copyright Ilya Tregubov <ilya.a.tregubov@gmail.com>
  34   */
  35  interface fieldname_mapping {
  36  
  37      /**
  38       * Get the suffixed field name for an activity field mapped from its itemnumber.
  39       *
  40       * For legacy reasons, the first itemnumber has no suffix on field names.
  41       *
  42       * @param string $component The component that the grade item belongs to
  43       * @param int $itemnumber The grade itemnumber
  44       * @param string $fieldname The name of the field to be rewritten
  45       * @return string The translated field name
  46       */
  47      public static function get_field_name_for_itemnumber(string $component, int $itemnumber, string $fieldname): string;
  48  }