buildScope( (string|int) $currentView, (object|int) $userIdOrObject, (int) $fid )

Location

/modules/formulize/include/functions.php

Description

Creates a valid scope that can be passed to the gatherDataset function, for retrieving data from the database according to the specified user’s permissions.

Parameters

$currentView - Can be one of the strings: mine, group, or all, signifying “the user’s entries,” or “their group’s entries,” or “all entries.” The highest possible scope available to the user, based on their permissions, will be used. Can also be a comma separated list of group ids instead, or a single group id, to declare a specific scope based on that particular set of groups. If you want the specified group ids to be limited to just the groups the user is a member of, put onlymembergroups as the first item in the comma separated list.
$userIdOrObject - The user id or object that represents the user for whom the scope is being built. Their permissions on the form will be taken into account to ensure the scope is limited to the data they have access to. If an invalid user id or object is passed, then the “anonymous user” is used, ie: user 0, no user, member of the Anonymous Users group.
$fid - The id number of the form for which the scope is being built.

Return Values

Returns an array with two values in it. Key zero is the scope which will be an array of groups, or arbitrary SQL to append to a database query. Key one is the value of currentView, which may have changed if the specified user did not have permission for the requested currentView value.

Key zero, the returned scope, can be passed directly into the gatherDataset function.

Examples

// Create the most permissive scope possible for user 12 on form 6, based on their permissions
$userId = 12;
$formId = 6;
$currentView = 'all'; // try to go big
list($scope, $currentView) = buildScope($currentView, $userId, $formId);
if($currenView != 'all') {
	print "Scope was reduced from 'all' based on the user's permissions";
}

// Find the group ids that make up 'group scope' for user 12 on form 6
// ie: which groups are 'their groups' for the purposes of seeing entries in form 6
// Note: if the user does not have any group level visibility permission on the form,
// then the scope will be reduced to only their own entries
$userId = 12;
$formId = 6;
$currentView = 'group';
list($scope, $currentView) = buildScope($currentView, $userId, $formId);
print "'Group Scope' groups for $userId on $formId are:";
print_r($scope);

// Print out the order numbers from the Orders form, for all the orders that belong
// to the currently logged in user's group(s)
global $xoopsUser; // the active, logged in user, either a user object or an empty value if there is no logged in user
$orderFormId = 6;
$currentView = 'group';
list($scope, $currentView) = buildScope($currentView, $xoopsUser, $orderFormId);
$data = gatherDataset($orderFormId, scope: $scope);
foreach($data as $entry) {
	print "Order Number: ".getValue($entry, 'order_number');
}

// Make the scope based on groups 17 and 33
global $xoopsUser; // the active, logged in user, either a user object or an empty value if there is no logged in user
$orderFormId = 6;
$currentView = '17,33';
list($scope, $currentView) = buildScope($currentView, $xoopsUser, $orderFormId);

// Make the scope based on groups 17 and 33, as long as the user is a member of those groups
global $xoopsUser; // the active, logged in user, either a user object or an empty value if there is no logged in user
$orderFormId = 6;
$currentView = 'onlymembergroups,17,33';
list($scope, $currentView) = buildScope($currentView, $xoopsUser, $orderFormId);

Getting Started

Help

Files