3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * The core concept of the system is an action performed on an object. Typically this will be a "data model" object
30 * as specified in the API specs. We attempt to keep the number and type of actions consistent
31 * and similar across all objects (thus providing both reuse and standards)
34 * @copyright CiviCRM LLC (c) 2004-2014
38 class CRM_Core_Action
{
41 * Different possible actions are defined here. Keep in sync with the
42 * constant from CRM_Core_Form for various modes.
72 //make sure MAX_ACTION = 2^n - 1 ( n = total number of actions )
75 * map the action names to the relevant constant. We perform
76 * bit manipulation operations so we can perform multiple
77 * actions on the same object if needed
79 * @var array _names tupe of variable name to action constant
85 static $_names = array(
87 'update' => self
::UPDATE
,
89 'delete' => self
::DELETE
,
90 'browse' => self
::BROWSE
,
91 'enable' => self
::ENABLE
,
92 'disable' => self
::DISABLE
,
93 'export' => self
::EXPORT
,
94 'preview' => self
::PREVIEW
,
97 'profile' => self
::PROFILE
,
98 'renew' => self
::RENEW
,
99 'detach' => self
::DETACH
,
100 'revert' => self
::REVERT
,
101 'close' => self
::CLOSE
,
102 'reopen' => self
::REOPEN
,
106 * the flipped version of the names array, initialized when used
111 static $_description;
115 * called by the request object to translate a string into a mask
119 * @internal param string $action the action to be resolved
121 * @return int the action mask corresponding to the input string
125 static function resolve($str) {
128 $items = explode('|', $str);
129 $action = self
::map($items);
135 * Given a string or an array of strings, determine the bitmask
136 * for this set of actions
138 * @param mixed either a single string or an array of strings
140 * @return int the action mask corresponding to the input args
145 static function map($item) {
148 if (is_array($item)) {
149 foreach ($item as $it) {
150 $mask |
= self
::mapItem($it);
155 return self
::mapItem($item);
160 * Given a string determine the bitmask for this specific string
162 * @param string the input action to process
164 * @return int the action mask corresponding to the input string
169 static function mapItem($item) {
170 $mask = CRM_Utils_Array
::value(trim($item), self
::$_names);
171 return $mask ?
$mask : 0;
176 * Given an action mask, find the corresponding description
178 * @param int the action mask
180 * @return string the corresponding action description
185 static function description($mask) {
186 if (!isset($_description)) {
187 self
::$_description = array_flip(self
::$_names);
190 return CRM_Utils_Array
::value($mask, self
::$_description, 'NO DESCRIPTION SET');
194 * given a set of links and a mask, return the html action string for
195 * the links associated with the mask
197 * @param array $links the set of link items
198 * @param int $mask the mask to be used. a null mask means all items
199 * @param array $values the array of values for parameter substitution in the link items
200 * @param string $extraULName enclosed extra links in this UL.
201 * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL.
204 * @param null $objectName
205 * @param null $objectId
207 * @return string the html string
211 static function formLink($links,
214 $extraULName = 'more',
215 $enclosedAllInSingleUL = FALSE,
220 $config = CRM_Core_Config
::singleton();
225 // make links indexed sequentially instead of by bitmask
226 // otherwise it's next to impossible to reliably add new ones
228 foreach ($links as $bit => $link) {
233 if ($op && $objectName && $objectId) {
234 CRM_Utils_Hook
::links($op, $objectName, $objectId, $seqLinks, $mask, $values);
239 foreach ($seqLinks as $i => $link) {
240 if (!$mask ||
!array_key_exists('bit', $link) ||
($mask & $link['bit'])) {
241 $extra = isset($link['extra']) ? self
::replace($link['extra'], $values) : NULL;
243 $frontend = (isset($link['fe'])) ?
TRUE : FALSE;
245 if (isset($link['qs']) && !CRM_Utils_System
::isNull($link['qs'])) {
246 $urlPath = CRM_Utils_System
::url(self
::replace($link['url'], $values),
247 self
::replace($link['qs'], $values), TRUE, NULL, TRUE, $frontend
251 $urlPath = CRM_Utils_Array
::value('url', $link, '#');
254 $classes = 'action-item crm-hover-button';
255 if (isset($link['ref'])) {
256 $classes .= ' ' . strtolower($link['ref']);
259 //get the user specified classes in.
260 if (isset($link['class'])) {
261 $className = is_array($link['class']) ?
implode(' ', $link['class']) : $link['class'];
262 $classes .= ' ' . strtolower($className);
265 if ($urlPath !== '#' && $frontend) {
266 $extra .= ' target="_blank"';
268 // Hack to make delete dialogs smaller
269 if (strpos($urlPath, '/delete') ||
strpos($urlPath, 'action=delete')) {
270 $classes .= " small-popup";
272 $url[] = sprintf('<a href="%s" class="%s" %s' . $extra . '>%s</a>',
275 !empty($link['title']) ?
"title='{$link['title']}' " : '',
283 if ($enclosedAllInSingleUL) {
285 CRM_Utils_String
::append($allLinks, '</li><li>', $mainLinks);
286 $allLinks = "{$extraULName}<ul class='panel'><li>{$allLinks}</li></ul>";
287 $result = "<span class='btn-slide crm-hover-button'>{$allLinks}</span>";
291 $extraLinks = array_splice($url, 2);
292 if (count($extraLinks) > 1) {
293 $mainLinks = array_slice($url, 0, 2);
294 CRM_Utils_String
::append($extra, '</li><li>', $extraLinks);
295 $extra = "{$extraULName}<ul class='panel'><li>{$extra}</li></ul>";
298 CRM_Utils_String
::append($resultLinks, '', $mainLinks);
300 $result = "<span>{$resultLinks}</span><span class='btn-slide crm-hover-button'>{$extra}</span>";
303 $result = "<span>{$resultLinks}</span>";
311 * given a string and an array of values, substitute the real values
312 * in the placeholder in the str in the CiviCRM format
314 * @param string $str the string to be replaced
315 * @param array $values the array of values for parameter substitution in the str
317 * @return string the substituted string
321 static function &replace(&$str, &$values) {
322 foreach ($values as $n => $v) {
323 $str = str_replace("%%$n%%", $v, $str);
329 * get the mask for a permission (view, edit or null)
331 * @param string the permission
333 * @return int the mask for the above permission
337 static function mask($permissions) {
339 if (!is_array($permissions) || CRM_Utils_System
::isNull($permissions)) {
342 //changed structure since we are handling delete separately - CRM-4418
343 if (in_array(CRM_Core_Permission
::VIEW
, $permissions)) {
344 $mask |
= self
::VIEW | self
::EXPORT | self
::BASIC | self
::ADVANCED | self
::BROWSE | self
::MAP | self
::PROFILE
;
346 if (in_array(CRM_Core_Permission
::DELETE
, $permissions)) {
347 $mask |
= self
::DELETE
;
349 if (in_array(CRM_Core_Permission
::EDIT
, $permissions)) {
350 //make sure we make self::MAX_ACTION = 2^n - 1
351 //if we add more actions; ( n = total number of actions )
352 $mask |
= (self
::MAX_ACTION
& ~self
::DELETE
);