mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-67585 core_course: add support for custom titles to content_item
Plugins have always been able to return either a string or a lang string when implementing the hook, 'get_shortcuts'. Since content_items will be the replacement for that stdClass implementation, we need a way for plugins to continue to have this flexibility. This just provides a small contract and some classes that plugins can use in future.
- Loading branch information
Showing
5 changed files
with
176 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Contains the lang_string_title class of value object, providing access to the value of a lang string. | ||
* | ||
* @package core | ||
* @subpackage course | ||
* @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
namespace core_course\local\entity; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* The lang_string_title class of value object, providing access to the value of a lang string. | ||
* | ||
* @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class lang_string_title implements title { | ||
|
||
/** @var string $component the component name. */ | ||
private $component; | ||
|
||
/** @var string $identifier the string identifier. */ | ||
private $identifier; | ||
|
||
/** | ||
* The lang_string_title constructor. | ||
* | ||
* @param string $identifier the component name. | ||
* @param string $component the string identifier. | ||
*/ | ||
public function __construct(string $identifier, string $component) { | ||
$this->identifier = $identifier; | ||
$this->component = $component; | ||
} | ||
|
||
/** | ||
* Returns the value of the wrapped string. | ||
* | ||
* @return string the value of the string. | ||
*/ | ||
public function get_value(): string { | ||
return get_string($this->identifier, $this->component); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Contains the string_title class of value object, which provides access to a simple string. | ||
* | ||
* @package core | ||
* @subpackage course | ||
* @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
namespace core_course\local\entity; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
/** | ||
* The string_title class of value object, which provides access to a simple string. | ||
* | ||
* @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class string_title implements title { | ||
|
||
/** @var string $title the title string. */ | ||
private $title; | ||
|
||
/** | ||
* The string_title constructor. | ||
* | ||
* @param string $title a string. | ||
*/ | ||
public function __construct(string $title) { | ||
$this->title = $title; | ||
} | ||
|
||
/** | ||
* Return the value of the wrapped string. | ||
* | ||
* @return string | ||
*/ | ||
public function get_value(): string { | ||
return $this->title; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<?php | ||
// This file is part of Moodle - http://moodle.org/ | ||
// | ||
// Moodle is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
// | ||
// Moodle is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
// | ||
// You should have received a copy of the GNU General Public License | ||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
/** | ||
* Contains the title value object interface, which provides a basic interface to a string. | ||
* | ||
* @package core | ||
* @subpackage course | ||
* @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
namespace core_course\local\entity; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
interface title { | ||
|
||
/** | ||
* Get the value of this title. | ||
*/ | ||
public function get_value(): string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters