Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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
 * Contains the favourite class, each instance being a representation of a DB row for the 'favourite' table.
19
 *
20
 * @package   core_favourites
21
 * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
22
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
namespace core_favourites\local\entity;
25
 
26
defined('MOODLE_INTERNAL') || die();
27
 
28
/**
29
 * Contains the favourite class, each instance being a representation of a DB row for the 'favourite' table.
30
 *
31
 * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
32
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33
 */
34
class favourite {
35
    /** @var int $id the id of the favourite.*/
36
    public $id;
37
 
38
    /** @var string $component the frankenstyle name of the component containing the favourited item. E.g. 'core_course'.*/
39
    public $component;
40
 
41
    /** @var string $itemtype the type of the item being marked as a favourite. E.g. 'course', 'conversation', etc.*/
42
    public $itemtype;
43
 
44
    /** @var int $itemid the id of the item that is being marked as a favourite. e.g course->id, conversation->id, etc.*/
45
    public $itemid;
46
 
47
    /** @var int $contextid the id of the context in which this favourite was created.*/
48
    public $contextid;
49
 
50
    /** @var int $userid the id of user who owns this favourite.*/
51
    public $userid;
52
 
53
    /** @var int $ordering the ordering of the favourite within it's favourite area.*/
54
    public $ordering;
55
 
56
    /** @var int $timecreated the time at which the favourite was created.*/
57
    public $timecreated;
58
 
59
    /** @var int $timemodified the time at which the last modification of the favourite took place.*/
60
    public $timemodified;
61
 
62
    /** @var string $uniquekey favourite unique key.*/
63
    public $uniquekey;
64
 
65
    /**
66
     * Favourite constructor.
67
     * @param string $component the frankenstyle name of the component containing the favourited item. E.g. 'core_course'.
68
     * @param string $itemtype the type of the item being marked as a favourite. E.g. 'course', 'conversation', etc.
69
     * @param int $itemid the id of the item that is being marked as a favourite. e.g course->id, conversation->id, etc.
70
     * @param int $contextid the id of the context in which this favourite was created.
71
     * @param int $userid the id of user who owns this favourite.
72
     */
73
    public function __construct(string $component, string $itemtype, int $itemid, int $contextid, int $userid) {
74
        $this->component = $component;
75
        $this->itemtype = $itemtype;
76
        $this->itemid = $itemid;
77
        $this->contextid = $contextid;
78
        $this->userid = $userid;
79
    }
80
}