]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Group_member.php
group_member includes self link, edit link
[quix0rs-gnu-social.git] / classes / Group_member.php
1 <?php
2 /**
3  * Table Definition for group_member
4  */
5
6 class Group_member extends Memcached_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     function pkeyGet($kv)
25     {
26         return Memcached_DataObject::pkeyGet('Group_member', $kv);
27     }
28
29     static function join($group_id, $profile_id)
30     {
31         $member = new Group_member();
32
33         $member->group_id   = $group_id;
34         $member->profile_id = $profile_id;
35         $member->created    = common_sql_now();
36
37         $result = $member->insert();
38
39         if (!$result) {
40             common_log_db_error($member, 'INSERT', __FILE__);
41             // TRANS: Exception thrown when joining a group fails.
42             throw new Exception(_("Group join failed."));
43         }
44
45         return true;
46     }
47
48     static function leave($group_id, $profile_id)
49     {
50         $member = Group_member::pkeyGet(array('group_id' => $group_id,
51                                               'profile_id' => $profile_id));
52
53         if (empty($member)) {
54             // TRANS: Exception thrown when trying to leave a group the user is not a member of.
55             throw new Exception(_("Not part of group."));
56         }
57
58         $result = $member->delete();
59
60         if (!$result) {
61             common_log_db_error($member, 'INSERT', __FILE__);
62             // TRANS: Exception thrown when trying to leave a group fails.
63             throw new Exception(_("Group leave failed."));
64         }
65
66         return true;
67     }
68
69     function getMember()
70     {
71         $member = Profile::staticGet('id', $this->profile_id);
72
73         if (empty($member)) {
74             // TRANS: Exception thrown providing an invalid profile ID.
75             // TRANS: %s is the invalid profile ID.
76             throw new Exception(sprintf(_("Profile ID %s is invalid."),$this->profile_id));
77         }
78
79         return $member;
80     }
81
82     function getGroup()
83     {
84         $group  = User_group::staticGet('id', $this->group_id);
85
86         if (empty($group)) {
87             // TRANS: Exception thrown providing an invalid group ID.
88             // TRANS: %s is the invalid group ID.
89             throw new Exception(sprintf(_("Group ID %s is invalid."),$this->group_id));
90         }
91
92         return $group;
93     }
94
95     function asActivity()
96     {
97         $member = $this->getMember();
98         $group  = $this->getGroup();
99
100         $act = new Activity();
101
102         $act->id = TagURI::mint('join:%d:%d:%s',
103                                 $member->id,
104                                 $group->id,
105                                 common_date_iso8601($this->created));
106
107         $act->actor     = ActivityObject::fromProfile($member);
108         $act->verb      = ActivityVerb::JOIN;
109         $act->objects[] = ActivityObject::fromGroup($group);
110
111         $act->time  = strtotime($this->created);
112         // TRANS: Activity title.
113         $act->title = _("Join");
114
115         // TRANS: Success message for subscribe to group attempt through OStatus.
116         // TRANS: %1$s is the member name, %2$s is the subscribed group's name.
117         $act->content = sprintf(_('%1$s has joined group %2$s.'),
118                                 $member->getBestName(),
119                                 $group->getBestName());
120
121         $url = common_local_url('AtomPubShowMembership',
122                                 array('profile' => $member->id,
123                                       'group' => $group->id));
124
125         $act->selfLink = $url;
126         $act->editLink = $url;
127
128         return $act;
129     }
130 }