]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Profile_role.php
Merge branch 'master' of gitorious.org:social/mainline
[quix0rs-gnu-social.git] / classes / Profile_role.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2009, StatusNet, Inc.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Affero General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Affero General Public License for more details.
15  *
16  * You should have received a copy of the GNU Affero General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 if (!defined('STATUSNET')) {
21     exit(1);
22 }
23
24 /**
25  * Table Definition for profile_role
26  */
27
28 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
29
30 class Profile_role extends Managed_DataObject
31 {
32     ###START_AUTOCODE
33     /* the code below is auto generated do not remove the above tag */
34
35     public $__table = 'profile_role';                    // table name
36     public $profile_id;                      // int(4)  primary_key not_null
37     public $role;                            // varchar(32)  primary_key not_null
38     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
39
40     /* the code above is auto generated do not remove the tag below */
41     ###END_AUTOCODE
42
43     public static function schemaDef()
44     {
45         return array(
46             'fields' => array(
47                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'account having the role'),
48                 'role' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'string representing the role'),
49                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the role was granted'),
50             ),
51             'primary key' => array('profile_id', 'role'),
52             'foreign keys' => array(
53                 'profile_role_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
54             ),
55             'indexes' => array('profile_role_role_created_profile_id_idx' => array('role', 'created', 'profile_id')),
56         );
57     }
58
59     const OWNER         = 'owner';
60     const MODERATOR     = 'moderator';
61     const ADMINISTRATOR = 'administrator';
62     const SANDBOXED     = 'sandboxed';
63     const SILENCED      = 'silenced';
64     const DELETED       = 'deleted'; // Pending final deletion of notices...
65
66     public static function isValid($role)
67     {
68         // @fixme could probably pull this from class constants
69         $known = array(self::OWNER,
70                        self::MODERATOR,
71                        self::ADMINISTRATOR,
72                        self::SANDBOXED,
73                        self::SILENCED);
74         return in_array($role, $known);
75     }
76
77     public static function isSettable($role)
78     {
79         $allowedRoles = array('administrator', 'moderator');
80         return self::isValid($role) && in_array($role, $allowedRoles);
81     }
82 }