| 1 | efrain | 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 |  * Description value object interface.
 | 
        
           |  |  | 19 |  *
 | 
        
           |  |  | 20 |  * @package    core_calendar
 | 
        
           |  |  | 21 |  * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
 | 
        
           |  |  | 22 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 | 
        
           |  |  | 23 |  */
 | 
        
           |  |  | 24 |   | 
        
           |  |  | 25 | namespace core_calendar\local\event\value_objects;
 | 
        
           |  |  | 26 |   | 
        
           |  |  | 27 | defined('MOODLE_INTERNAL') || die();
 | 
        
           |  |  | 28 |   | 
        
           |  |  | 29 | /**
 | 
        
           |  |  | 30 |  * Interface for a description value object.
 | 
        
           |  |  | 31 |  *
 | 
        
           |  |  | 32 |  * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
 | 
        
           |  |  | 33 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 | 
        
           |  |  | 34 |  */
 | 
        
           |  |  | 35 | interface description_interface {
 | 
        
           |  |  | 36 |     /**
 | 
        
           |  |  | 37 |      * Get the description's text.
 | 
        
           |  |  | 38 |      *
 | 
        
           |  |  | 39 |      * @return string The description's text.
 | 
        
           |  |  | 40 |      */
 | 
        
           |  |  | 41 |     public function get_value();
 | 
        
           |  |  | 42 |   | 
        
           |  |  | 43 |     /**
 | 
        
           |  |  | 44 |      * Get the description's format.
 | 
        
           |  |  | 45 |      *
 | 
        
           |  |  | 46 |      * @return int The description's format.
 | 
        
           |  |  | 47 |      */
 | 
        
           |  |  | 48 |     public function get_format();
 | 
        
           |  |  | 49 | }
 |