classes/Local_group.php

   1 <?php
   2 /**
   3  * Table Definition for local_group
   4  */
   5
   6 class Local_group extends Managed_DataObject
   7 {
   8     ###START_AUTOCODE
   9     /* the code below is auto generated do not remove the above tag */
  10
  11     public $__table = 'local_group';                     // table name
  12     public $group_id;                        // int(4)  primary_key not_null
  13     public $nickname;                        // varchar(64)  unique_key
  14     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
  15     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  16
  17     /* the code above is auto generated do not remove the tag below */
  18     ###END_AUTOCODE
  19
  20     public static function schemaDef()
  21     {
  22         return array(
  23             'description' => 'Record for a user group on the local site, with some additional info not in user_group',
  24             'fields' => array(
  25                 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'group represented'),
  26                 'nickname' => array('type' => 'varchar', 'length' => 64, 'description' => 'group represented'),
  27
  28                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  29                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  30             ),
  31             'primary key' => array('group_id'),
  32             'foreign keys' => array(
  33                 'local_group_group_id_fkey' => array('user_group', array('group_id' => 'id')),
  34             ),
  35             'unique keys' => array(
  36                 'local_group_nickname_key' => array('nickname'),
  37             ),
  38         );
  39     }
  40
  41     public function getProfile()
  42     {
  43         $group = $this->getGroup();
  44         if (!$group instanceof User_group) {
  45             return null;    // TODO: Throw exception when other code is ready
  46         }
  47         return $group->getProfile();
  48     }
  49
  50     public function getGroup()
  51     {
  52         return User_group::getKV('id', $this->group_id);
  53     }
  54
  55     function setNickname($nickname)
  56     {
  57         $this->decache();
  58         $qry = 'UPDATE local_group set nickname = "'.$this->escape($nickname).'" where group_id = ' . $this->group_id;
  59
  60         $result = $this->query($qry);
  61
  62         if ($result) {
  63             $this->nickname = $nickname;
  64             $this->fixupTimestamps();
  65             $this->encache();
  66         } else {
  67             common_log_db_error($local, 'UPDATE', __FILE__);
  68             // TRANS: Server exception thrown when updating a local group fails.
  69             throw new ServerException(_('Could not update local group.'));
  70         }
  71
  72         return $result;
  73     }
  74 }