]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Group_member.php
fix calls to staticGet() to avoid problems with default args
[quix0rs-gnu-social.git] / classes / Group_member.php
1 <?php
2 /**
3  * Table Definition for group_member
4  */
5
6 class Group_member extends Managed_DataObject
7 {
8     ###START_AUTOCODE
9     /* the code below is auto generated do not remove the above tag */
10
11     public $__table = 'group_member';                    // table name
12     public $group_id;                        // int(4)  primary_key not_null
13     public $profile_id;                      // int(4)  primary_key not_null
14     public $is_admin;                        // tinyint(1)
15     public $created;                         // datetime()   not_null
16     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
17
18     /* Static get */
19     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Group_member',$k,$v); }
20
21     /* the code above is auto generated do not remove the tag below */
22     ###END_AUTOCODE
23
24     public static function schemaDef()
25     {
26         return array(
27             'fields' => array(
28                 'group_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to user_group'),
29                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'foreign key to profile table'),
30                 'is_admin' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'is this user an admin?'),
31
32                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
33                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
34             ),
35             'primary key' => array('group_id', 'profile_id'),
36             'foreign keys' => array(
37                 'group_member_group_id_fkey' => array('user_group', array('group_id' => 'id')),
38                 'group_member_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
39             ),
40             'indexes' => array(
41                 // @fixme probably we want a (profile_id, created) index here?
42                 'group_member_profile_id_idx' => array('profile_id'),
43                 'group_member_created_idx' => array('created'),
44             ),
45         );
46     }
47
48     function pkeyGet($kv)
49     {
50         return Memcached_DataObject::pkeyGet('Group_member', $kv);
51     }
52
53     /**
54      * Method to add a user to a group.
55      * In most cases, you should call Profile->joinGroup() instead.
56      *
57      * @param integer $group_id   Group to add to
58      * @param integer $profile_id Profile being added
59      * 
60      * @return Group_member new membership object
61      */
62
63     static function join($group_id, $profile_id)
64     {
65         $member = new Group_member();
66
67         $member->group_id   = $group_id;
68         $member->profile_id = $profile_id;
69         $member->created    = common_sql_now();
70
71         $result = $member->insert();
72
73         if (!$result) {
74             common_log_db_error($member, 'INSERT', __FILE__);
75             // TRANS: Exception thrown when joining a group fails.
76             throw new Exception(_("Group join failed."));
77         }
78
79         return $member;
80     }
81
82     static function leave($group_id, $profile_id)
83     {
84         $member = Group_member::pkeyGet(array('group_id' => $group_id,
85                                               'profile_id' => $profile_id));
86
87         if (empty($member)) {
88             // TRANS: Exception thrown when trying to leave a group the user is not a member of.
89             throw new Exception(_("Not part of group."));
90         }
91
92         $result = $member->delete();
93
94         if (!$result) {
95             common_log_db_error($member, 'INSERT', __FILE__);
96             // TRANS: Exception thrown when trying to leave a group fails.
97             throw new Exception(_("Group leave failed."));
98         }
99
100         return true;
101     }
102
103     function getMember()
104     {
105         $member = Profile::staticGet('id', $this->profile_id);
106
107         if (empty($member)) {
108             // TRANS: Exception thrown providing an invalid profile ID.
109             // TRANS: %s is the invalid profile ID.
110             throw new Exception(sprintf(_("Profile ID %s is invalid."),$this->profile_id));
111         }
112
113         return $member;
114     }
115
116     function getGroup()
117     {
118         $group  = User_group::staticGet('id', $this->group_id);
119
120         if (empty($group)) {
121             // TRANS: Exception thrown providing an invalid group ID.
122             // TRANS: %s is the invalid group ID.
123             throw new Exception(sprintf(_("Group ID %s is invalid."),$this->group_id));
124         }
125
126         return $group;
127     }
128
129     /**
130      * Get stream of memberships by member
131      *
132      * @param integer $memberId profile ID of the member to fetch for
133      * @param integer $offset   offset from start of stream to get
134      * @param integer $limit    number of memberships to get
135      *
136      * @return Group_member stream of memberships, use fetch() to iterate
137      */
138
139     static function byMember($memberId, $offset=0, $limit=GROUPS_PER_PAGE)
140     {
141         $membership = new Group_member();
142
143         $membership->profile_id = $memberId;
144
145         $membership->orderBy('created DESC');
146
147         $membership->limit($offset, $limit);
148
149         $membership->find();
150
151         return $membership;
152     }
153
154     function asActivity()
155     {
156         $member = $this->getMember();
157         $group  = $this->getGroup();
158
159         $act = new Activity();
160
161         $act->id = TagURI::mint('join:%d:%d:%s',
162                                 $member->id,
163                                 $group->id,
164                                 common_date_iso8601($this->created));
165
166         $act->actor     = ActivityObject::fromProfile($member);
167         $act->verb      = ActivityVerb::JOIN;
168         $act->objects[] = ActivityObject::fromGroup($group);
169
170         $act->time  = strtotime($this->created);
171         // TRANS: Activity title.
172         $act->title = _("Join");
173
174         // TRANS: Success message for subscribe to group attempt through OStatus.
175         // TRANS: %1$s is the member name, %2$s is the subscribed group's name.
176         $act->content = sprintf(_('%1$s has joined group %2$s.'),
177                                 $member->getBestName(),
178                                 $group->getBestName());
179
180         $url = common_local_url('AtomPubShowMembership',
181                                 array('profile' => $member->id,
182                                       'group' => $group->id));
183
184         $act->selfLink = $url;
185         $act->editLink = $url;
186
187         return $act;
188     }
189
190     /**
191      * Send notifications via email etc to group administrators about
192      * this exciting new membership!
193      */
194     public function notify()
195     {
196         mail_notify_group_join($this->getGroup(), $this->getMember());
197     }
198 }