[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   * Contains the lang_string_title class of value object, providing access to the value of a lang string.
  19   *
  20   * @package    core
  21   * @subpackage course
  22   * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  namespace core_course\local\entity;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The lang_string_title class of value object, providing access to the value of a lang string.
  31   *
  32   * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class lang_string_title implements title {
  36  
  37      /** @var string $component the component name. */
  38      private $component;
  39  
  40      /** @var string $identifier the string identifier. */
  41      private $identifier;
  42  
  43      /**
  44       * The lang_string_title constructor.
  45       *
  46       * @param string $identifier the component name.
  47       * @param string $component the string identifier.
  48       */
  49      public function __construct(string $identifier, string $component) {
  50          $this->identifier = $identifier;
  51          $this->component = $component;
  52      }
  53  
  54      /**
  55       * Returns the value of the wrapped string.
  56       *
  57       * @return string the value of the string.
  58       */
  59      public function get_value(): string {
  60          return get_string($this->identifier, $this->component);
  61      }
  62  }