Namespaces

Classes

Interfaces

Exceptions

Functions

1: <?php
2: /**
3: * Extended User Profile
4: *
5: * You may not change or alter any portion of this comment or credits
6: * of supporting developers from this source code or any supporting source code
7: * which is considered copyrighted (c) material of the original comment or credit authors.
8: * This program is distributed in the hope that it will be useful,
9: * but WITHOUT ANY WARRANTY; without even the implied warranty of
10: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11: *
12: * @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
13: * @license GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
14: * @package profile
15: * @since 2.3.0
16: * @author Jan Pedersen
17: * @author Taiwen Jiang <phppp@users.sourceforge.net>
18: * @param $module
19: * @return bool
20: */
21:
22: function xoops_module_install_profile(XoopsModule $module)
23: {
24: global $module_id;
25: $module_id = $module->getVar('mid');
26: xoops_loadLanguage('user');
27:
28: // Create registration steps
29: profile_install_addStep(_PROFILE_MI_STEP_BASIC, '', 1, 0);
30: profile_install_addStep(_PROFILE_MI_STEP_COMPLEMENTARY, '', 2, 1);
31:
32: // Create categories
33: profile_install_addCategory(_PROFILE_MI_CATEGORY_PERSONAL, 1);
34: profile_install_addCategory(_PROFILE_MI_CATEGORY_MESSAGING, 2);
35: profile_install_addCategory(_PROFILE_MI_CATEGORY_SETTINGS, 3);
36: profile_install_addCategory(_PROFILE_MI_CATEGORY_COMMUNITY, 4);
37:
38: // Add user fields
39: xoops_loadLanguage('notification');
40: xoops_loadLanguage('main', $module->getVar('dirname', 'n'));
41: include_once $GLOBALS['xoops']->path('include/notification_constants.php');
42: $umode_options = array(
43: 'nest' => _NESTED,
44: 'flat' => _FLAT,
45: 'thread' => _THREADED);
46: $uorder_options = array(
47: 0 => _OLDESTFIRST,
48: 1 => _NEWESTFIRST);
49: $notify_mode_options = array(
50: XOOPS_NOTIFICATION_MODE_SENDALWAYS => _NOT_MODE_SENDALWAYS,
51: XOOPS_NOTIFICATION_MODE_SENDONCETHENDELETE => _NOT_MODE_SENDONCE,
52: XOOPS_NOTIFICATION_MODE_SENDONCETHENWAIT => _NOT_MODE_SENDONCEPERLOGIN);
53: $notify_method_options = array(
54: XOOPS_NOTIFICATION_METHOD_DISABLE => _NOT_METHOD_DISABLE,
55: XOOPS_NOTIFICATION_METHOD_PM => _NOT_METHOD_PM,
56: XOOPS_NOTIFICATION_METHOD_EMAIL => _NOT_METHOD_EMAIL);
57:
58: profile_install_addField('name', _US_REALNAME, '', 1, 'textbox', 1, 1, 1, array(), 2, 255);
59: profile_install_addField('user_from', _US_LOCATION, '', 1, 'textbox', 1, 2, 1, array(), 2, 255);
60: profile_install_addField('timezone_offset', _US_TIMEZONE, '', 1, 'timezone', 1, 3, 1, array(), 2, 0);
61: profile_install_addField('user_occ', _US_OCCUPATION, '', 1, 'textbox', 1, 4, 1, array(), 2, 255);
62: profile_install_addField('user_intrest', _US_INTEREST, '', 1, 'textbox', 1, 5, 1, array(), 2, 255);
63: profile_install_addField('bio', _US_EXTRAINFO, '', 1, 'textarea', 2, 6, 1, array(), 2, 0);
64: profile_install_addField('user_regdate', _US_MEMBERSINCE, '', 1, 'datetime', 3, 7, 0, array(), 0, 10);
65:
66: profile_install_addField('user_icq', _US_ICQ, '', 2, 'textbox', 1, 1, 0, array(), 0, 255, false);
67: profile_install_addField('user_aim', _US_AIM, '', 2, 'textbox', 1, 2, 0, array(), 0, 255, false);
68: profile_install_addField('user_yim', _US_YIM, '', 2, 'textbox', 1, 3, 0, array(), 0, 255, false);
69: profile_install_addField('user_msnm', _US_MSNM, '', 2, 'textbox', 1, 4, 0, array(), 0, 255, false);
70:
71: profile_install_addField('user_viewemail', _US_ALLOWVIEWEMAIL, '', 3, 'yesno', 3, 1, 1, array(), 2, 1, false);
72: profile_install_addField('attachsig', _US_SHOWSIG, '', 3, 'yesno', 3, 2, 1, array(), 0, 1, false);
73: profile_install_addField('user_mailok', _US_MAILOK, '', 3, 'yesno', 3, 3, 1, array(), 2, 1, false);
74: profile_install_addField('theme', _PROFILE_MA_THEME, '', 3, 'theme', 1, 4, 1, array(), 0, 0, false);
75: profile_install_addField('umode', _US_CDISPLAYMODE, '', 3, 'select', 1, 5, 1, $umode_options, 0, 0, false);
76: profile_install_addField('uorder', _US_CSORTORDER, '', 3, 'select', 3, 6, 1, $uorder_options, 0, 0, false);
77: profile_install_addField('notify_mode', _NOT_NOTIFYMODE, '', 3, 'select', 3, 7, 1, $notify_mode_options, 0, 0, false);
78: profile_install_addField('notify_method', _NOT_NOTIFYMETHOD, '', 3, 'select', 3, 8, 1, $notify_method_options, 0, 0, false);
79:
80: profile_install_addField('url', _PROFILE_MI_URL_TITLE, '', 4, 'textbox', 1, 1, 1, array(), 2, 255);
81: profile_install_addField('posts', _US_POSTS, '', 4, 'textbox', 3, 2, 0, array(), 0, 255);
82: profile_install_addField('rank', _US_RANK, '', 4, 'rank', 3, 3, 2, array(), 0, 0);
83: profile_install_addField('last_login', _US_LASTLOGIN, '', 4, 'datetime', 3, 4, 0, array(), 0, 10);
84: profile_install_addField('user_sig', _US_SIGNATURE, '', 4, 'dhtml', 1, 5, 1, array(), 0, 0);
85:
86: profile_install_initializeProfiles();
87:
88: return true;
89: }
90:
91: function profile_install_initializeProfiles()
92: {
93: global $module_id;
94:
95: $GLOBALS['xoopsDB']->queryF(' INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('profile_profile') . ' (profile_id) ' . ' SELECT uid ' . ' FROM ' . $GLOBALS['xoopsDB']->prefix('users'));
96:
97: $sql = 'INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('group_permission') . ' (gperm_groupid, gperm_itemid, gperm_modid, gperm_name) ' . ' VALUES ' . ' (' . XOOPS_GROUP_ADMIN . ', ' . XOOPS_GROUP_ADMIN . ", {$module_id}, 'profile_access'), " . ' (' . XOOPS_GROUP_ADMIN . ', ' . XOOPS_GROUP_USERS . ", {$module_id}, 'profile_access'), " . ' (' . XOOPS_GROUP_USERS . ', ' . XOOPS_GROUP_USERS . ", {$module_id}, 'profile_access'), " . ' (' . XOOPS_GROUP_ANONYMOUS . ', ' . XOOPS_GROUP_USERS . ", {$module_id}, 'profile_access') " . ' ';
98: $GLOBALS['xoopsDB']->queryF($sql);
99: }
100:
101: // canedit: 0 - no; 1 - admin; 2 - admin & owner
102: /**
103: * @param $name
104: * @param $title
105: * @param $description
106: * @param $category
107: * @param $type
108: * @param $valuetype
109: * @param $weight
110: * @param $canedit
111: * @param $options
112: * @param $step_id
113: * @param $length
114: * @param bool $visible
115: *
116: * @return bool
117: */
118: function profile_install_addField($name, $title, $description, $category, $type, $valuetype, $weight, $canedit, $options, $step_id, $length, $visible = true)
119: {
120: global $module_id;
121:
122: $profilefield_handler = xoops_getModuleHandler('field', 'profile');
123: $obj = $profilefield_handler->create();
124: $obj->setVar('field_name', $name, true);
125: $obj->setVar('field_moduleid', $module_id, true);
126: $obj->setVar('field_show', 1);
127: $obj->setVar('field_edit', $canedit ? 1 : 0);
128: $obj->setVar('field_config', 0);
129: $obj->setVar('field_title', strip_tags($title), true);
130: $obj->setVar('field_description', strip_tags($description), true);
131: $obj->setVar('field_type', $type, true);
132: $obj->setVar('field_valuetype', $valuetype, true);
133: $obj->setVar('field_options', $options, true);
134: if ($canedit) {
135: $obj->setVar('field_maxlength', $length, true);
136: }
137:
138: $obj->setVar('field_weight', $weight, true);
139: $obj->setVar('cat_id', $category, true);
140: $obj->setVar('step_id', $step_id, true);
141: $profilefield_handler->insert($obj);
142:
143: profile_install_setPermissions($obj->getVar('field_id'), $module_id, $canedit, $visible);
144:
145: return true;
146: /*
147: //$GLOBALS['xoopsDB']->query("INSERT INTO ".$GLOBALS['xoopsDB']->prefix("profile_field")." VALUES (0, {$category}, '{$type}', {$valuetype}, '{$name}', " . $GLOBALS['xoopsDB']->quote($title) . ", " . $GLOBALS['xoopsDB']->quote($description) . ", 0, {$length}, {$weight}, '', 1, {$canedit}, 1, 0, '" . serialize($options) . "', {$step_id})");
148: $gperm_itemid = $obj->getVar('field_id');
149: unset($obj);
150: $gperm_modid = $module_id;
151: $sql = "INSERT INTO " . $GLOBALS['xoopsDB']->prefix("group_permission") .
152: " (gperm_groupid, gperm_itemid, gperm_modid, gperm_name) " .
153: " VALUES " .
154: ($canedit ?
155: " (" . XOOPS_GROUP_ADMIN . ", {$gperm_itemid}, {$gperm_modid}, 'profile_edit'), "
156: : "" ) .
157: ($canedit == 1 ?
158: " (" . XOOPS_GROUP_USERS . ", {$gperm_itemid}, {$gperm_modid}, 'profile_edit'), "
159: : "" ) .
160: " (" . XOOPS_GROUP_ADMIN . ", {$gperm_itemid}, {$gperm_modid}, 'profile_search'), " .
161: " (" . XOOPS_GROUP_USERS . ", {$gperm_itemid}, {$gperm_modid}, 'profile_search') " .
162: " ";
163: $GLOBALS['xoopsDB']->query($sql);
164:
165: if ($visible) {
166: $sql = "INSERT INTO " . $GLOBALS['xoopsDB']->prefix("profile_visibility") .
167: " (field_id, user_group, profile_group) " .
168: " VALUES " .
169: " ({$gperm_itemid}, " . XOOPS_GROUP_ADMIN . ", " . XOOPS_GROUP_ADMIN . "), " .
170: " ({$gperm_itemid}, " . XOOPS_GROUP_ADMIN . ", " . XOOPS_GROUP_USERS . "), " .
171: " ({$gperm_itemid}, " . XOOPS_GROUP_USERS . ", " . XOOPS_GROUP_ADMIN . "), " .
172: " ({$gperm_itemid}, " . XOOPS_GROUP_USERS . ", " . XOOPS_GROUP_USERS . "), " .
173: " ({$gperm_itemid}, " . XOOPS_GROUP_ANONYMOUS . ", " . XOOPS_GROUP_ADMIN . "), " .
174: " ({$gperm_itemid}, " . XOOPS_GROUP_ANONYMOUS . ", " . XOOPS_GROUP_USERS . ")" .
175: " ";
176: $GLOBALS['xoopsDB']->query($sql);
177: }
178: */
179: }
180:
181: /**
182: * @param $field_id
183: * @param $module_id
184: * @param $canedit
185: * @param $visible
186: */
187: function profile_install_setPermissions($field_id, $module_id, $canedit, $visible)
188: {
189: // do not assign any permissions for these defunct fields
190: $skip_icq_aim_yim_msnm = array(8, 9, 10, 11);
191:
192: if (!in_array($field_id, $skip_icq_aim_yim_msnm)) {
193: $gperm_itemid = $field_id;
194: $gperm_modid = $module_id;
195: $sql = 'INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('group_permission') . ' (gperm_groupid, gperm_itemid, gperm_modid, gperm_name) ' . ' VALUES ' . ($canedit ? ' (' . XOOPS_GROUP_ADMIN . ", {$gperm_itemid}, {$gperm_modid}, 'profile_edit'), " : '') . ($canedit == 1 ? ' (' . XOOPS_GROUP_USERS . ", {$gperm_itemid}, {$gperm_modid}, 'profile_edit'), " : '') . ' (' . XOOPS_GROUP_ADMIN . ", {$gperm_itemid}, {$gperm_modid}, 'profile_search'), " . ' (' . XOOPS_GROUP_USERS . ", {$gperm_itemid}, {$gperm_modid}, 'profile_search') " . ' ';
196: $GLOBALS['xoopsDB']->queryF($sql);
197: }
198:
199: if ($visible) {
200: $sql = 'INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('profile_visibility') . ' (field_id, user_group, profile_group) ' . ' VALUES ' . " ({$gperm_itemid}, " . XOOPS_GROUP_ADMIN . ', ' . XOOPS_GROUP_ADMIN . '), ' . " ({$gperm_itemid}, " . XOOPS_GROUP_ADMIN . ', ' . XOOPS_GROUP_USERS . '), ' . " ({$gperm_itemid}, " . XOOPS_GROUP_USERS . ', ' . XOOPS_GROUP_ADMIN . '), ' . " ({$gperm_itemid}, " . XOOPS_GROUP_USERS . ', ' . XOOPS_GROUP_USERS . '), ' . " ({$gperm_itemid}, " . XOOPS_GROUP_ANONYMOUS . ', ' . XOOPS_GROUP_ADMIN . '), ' . " ({$gperm_itemid}, " . XOOPS_GROUP_ANONYMOUS . ', ' . XOOPS_GROUP_USERS . ')' . ' ';
201: $GLOBALS['xoopsDB']->queryF($sql);
202: }
203: }
204:
205: /**
206: * @param $name
207: * @param $weight
208: */
209: function profile_install_addCategory($name, $weight)
210: {
211: $GLOBALS['xoopsDB']->query('INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('profile_category') . ' VALUES (0, ' . $GLOBALS['xoopsDB']->quote($name) . ", '', {$weight})");
212: }
213:
214: /**
215: * @param $name
216: * @param $desc
217: * @param $order
218: * @param $save
219: */
220: function profile_install_addStep($name, $desc, $order, $save)
221: {
222: $GLOBALS['xoopsDB']->query('INSERT INTO ' . $GLOBALS['xoopsDB']->prefix('profile_regstep') . ' VALUES (0, ' . $GLOBALS['xoopsDB']->quote($name) . ', ' . $GLOBALS['xoopsDB']->quote($desc) . ", {$order}, {$save})");
223: }
224:
API documentation generated by ApiGen v7.0.0-alpha.6