self::ADD,
'update' => self::UPDATE,
'view' => self::VIEW,
'delete' => self::DELETE,
'browse' => self::BROWSE,
'enable' => self::ENABLE,
'disable' => self::DISABLE,
'export' => self::EXPORT,
'preview' => self::PREVIEW,
'map' => self::MAP,
'copy' => self::COPY,
'profile' => self::PROFILE,
'renew' => self::RENEW,
'detach' => self::DETACH,
'revert' => self::REVERT,
'close' => self::CLOSE,
'reopen' => self::REOPEN,
);
/**
* The flipped version of the names array, initialized when used
*
* @var array
*/
static $_description;
/**
* Called by the request object to translate a string into a mask.
*
* @param string $str
* The action to be resolved.
*
* @return int
* the action mask corresponding to the input string
*/
public static function resolve($str) {
$action = 0;
if ($str) {
$items = explode('|', $str);
$action = self::map($items);
}
return $action;
}
/**
* Given a string or an array of strings, determine the bitmask
* for this set of actions
*
* @param mixed $item
* Either a single string or an array of strings.
*
* @return int
* the action mask corresponding to the input args
*/
public static function map($item) {
$mask = 0;
if (is_array($item)) {
foreach ($item as $it) {
$mask |= self::mapItem($it);
}
return $mask;
}
else {
return self::mapItem($item);
}
}
/**
* Given a string determine the bitmask for this specific string.
*
* @param string $item
* The input action to process.
*
* @return int
* the action mask corresponding to the input string
*/
public static function mapItem($item) {
$mask = CRM_Utils_Array::value(trim($item), self::$_names);
return $mask ? $mask : 0;
}
/**
*
* Given an action mask, find the corresponding description
*
* @param int $mask
* The action mask.
*
* @return string
* the corresponding action description
*/
public static function description($mask) {
if (!isset(self::$_description)) {
self::$_description = array_flip(self::$_names);
}
return CRM_Utils_Array::value($mask, self::$_description, 'NO DESCRIPTION SET');
}
/**
* Given a set of links and a mask, return the html action string for
* the links associated with the mask
*
* @param array $links
* The set of link items.
* @param int $mask
* The mask to be used. a null mask means all items.
* @param array $values
* The array of values for parameter substitution in the link items.
* @param string $extraULName
* Enclosed extra links in this UL.
* @param bool $enclosedAllInSingleUL
* Force to enclosed all links in single UL.
*
* @param null $op
* @param null $objectName
* @param int $objectId
*
* @return string
* the html string
*/
public static function formLink(
$links,
$mask,
$values,
$extraULName = 'more',
$enclosedAllInSingleUL = FALSE,
$op = NULL,
$objectName = NULL,
$objectId = NULL
) {
if (empty($links)) {
return NULL;
}
// make links indexed sequentially instead of by bitmask
// otherwise it's next to impossible to reliably add new ones
$seqLinks = array();
foreach ($links as $bit => $link) {
$link['bit'] = $bit;
$seqLinks[] = $link;
}
if ($op && $objectName && $objectId) {
CRM_Utils_Hook::links($op, $objectName, $objectId, $seqLinks, $mask, $values);
}
$url = array();
foreach ($seqLinks as $i => $link) {
if (!$mask || !array_key_exists('bit', $link) || ($mask & $link['bit'])) {
$extra = isset($link['extra']) ? self::replace($link['extra'], $values) : NULL;
$frontend = (isset($link['fe'])) ? TRUE : FALSE;
if (isset($link['qs']) && !CRM_Utils_System::isNull($link['qs'])) {
$urlPath = CRM_Utils_System::url(self::replace($link['url'], $values),
self::replace($link['qs'], $values), FALSE, NULL, TRUE, $frontend
);
}
else {
$urlPath = CRM_Utils_Array::value('url', $link, '#');
}
$classes = 'action-item crm-hover-button';
if (isset($link['ref'])) {
$classes .= ' ' . strtolower($link['ref']);
}
//get the user specified classes in.
if (isset($link['class'])) {
$className = is_array($link['class']) ? implode(' ', $link['class']) : $link['class'];
$classes .= ' ' . strtolower($className);
}
if ($urlPath !== '#' && $frontend) {
$extra .= ' target="_blank"';
}
// Hack to make delete dialogs smaller
if (strpos($urlPath, '/delete') || strpos($urlPath, 'action=delete')) {
$classes .= " small-popup";
}
$url[] = sprintf('%s',
$urlPath,
$classes,
!empty($link['title']) ? "title='{$link['title']}' " : '',
$link['name']
);
}
}
$mainLinks = $url;
if ($enclosedAllInSingleUL) {
$allLinks = '';
CRM_Utils_String::append($allLinks, '', $mainLinks);
$allLinks = "{$extraULName}";
$result = "{$allLinks}";
}
else {
$extra = '';
$extraLinks = array_splice($url, 2);
if (count($extraLinks) > 1) {
$mainLinks = array_slice($url, 0, 2);
CRM_Utils_String::append($extra, '', $extraLinks);
$extra = "{$extraULName}";
}
$resultLinks = '';
CRM_Utils_String::append($resultLinks, '', $mainLinks);
if ($extra) {
$result = "{$resultLinks}{$extra}";
}
else {
$result = "{$resultLinks}";
}
}
return $result;
}
/**
* Given a string and an array of values, substitute the real values
* in the placeholder in the str in the CiviCRM format
*
* @param string $str
* The string to be replaced.
* @param array $values
* The array of values for parameter substitution in the str.
*
* @return string
* the substituted string
*/
public static function &replace(&$str, &$values) {
foreach ($values as $n => $v) {
$str = str_replace("%%$n%%", $v, $str);
}
return $str;
}
/**
* Get the mask for a permission (view, edit or null)
*
* @param array $permissions
*
* @return int
* The mask for the above permission
*/
public static function mask($permissions) {
$mask = NULL;
if (!is_array($permissions) || CRM_Utils_System::isNull($permissions)) {
return $mask;
}
//changed structure since we are handling delete separately - CRM-4418
if (in_array(CRM_Core_Permission::VIEW, $permissions)) {
$mask |= self::VIEW | self::EXPORT | self::BASIC | self::ADVANCED | self::BROWSE | self::MAP | self::PROFILE;
}
if (in_array(CRM_Core_Permission::DELETE, $permissions)) {
$mask |= self::DELETE;
}
if (in_array(CRM_Core_Permission::EDIT, $permissions)) {
//make sure we make self::MAX_ACTION = 2^n - 1
//if we add more actions; ( n = total number of actions )
$mask |= (self::MAX_ACTION & ~self::DELETE);
}
return $mask;
}
}