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     /* Static get */
  41     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Profile_role',$k,$v); }
  42
  43     /* the code above is auto generated do not remove the tag below */
  44     ###END_AUTOCODE
  45
  46     public static function schemaDef()
  47     {
  48         return array(
  49             'fields' => array(
  50                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'account having the role'),
  51                 'role' => array('type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'string representing the role'),
  52                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the role was granted'),
  53             ),
  54             'primary key' => array('profile_id', 'role'),
  55             'foreign keys' => array(
  56                 'profile_role_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
  57             ),
  58             'indexes' => array('profile_role_role_created_profile_id_idx' => array('role', 'created', 'profile_id')),
  59         );
  60     }
  61
  62     function pkeyGet($kv)
  63     {
  64         return Memcached_DataObject::pkeyGet('Profile_role', $kv);
  65     }
  66
  67     const OWNER         = 'owner';
  68     const MODERATOR     = 'moderator';
  69     const ADMINISTRATOR = 'administrator';
  70     const SANDBOXED     = 'sandboxed';
  71     const SILENCED      = 'silenced';
  72     const DELETED       = 'deleted'; // Pending final deletion of notices...
  73
  74     public static function isValid($role)
  75     {
  76         // @fixme could probably pull this from class constants
  77         $known = array(self::OWNER,
  78                        self::MODERATOR,
  79                        self::ADMINISTRATOR,
  80                        self::SANDBOXED,
  81                        self::SILENCED);
  82         return in_array($role, $known);
  83     }
  84
  85     public static function isSettable($role)
  86     {
  87         $allowedRoles = array('administrator', 'moderator');
  88         return self::isValid($role) && in_array($role, $allowedRoles);
  89     }
  90 }