All Data Structures Functions Variables Pages
GlobalSearchUtil.php
1 <?php
2  /*********************************************************************************
3  * Zurmo is a customer relationship management program developed by
4  * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
5  *
6  * Zurmo is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Affero General Public License version 3 as published by the
8  * Free Software Foundation with the addition of the following permission added
9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10  * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
12  *
13  * Zurmo is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Affero General Public License along with
19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  * 02110-1301 USA.
22  *
23  * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
24  * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
25  *
26  * The interactive user interfaces in original and modified versions
27  * of this program must display Appropriate Legal Notices, as required under
28  * Section 5 of the GNU Affero General Public License version 3.
29  *
30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31  * these Appropriate Legal Notices must retain the display of the Zurmo
32  * logo and Zurmo copyright notice. If the display of the logo is not reasonably
33  * feasible for technical reasons, the Appropriate Legal Notices must display the words
34  * "Copyright Zurmo Inc. 2017. All rights reserved".
35  ********************************************************************************/
36 
41  {
49  {
50  assert('$user->id > 0');
51  try
52  {
53  // not using default value to save cpu cycles on requests that follow the first exception.
54  return GeneralCache::getEntry(self::getGlobalSearchScopingCacheIdentifier($user));
55  }
56  catch (NotFoundException $e)
57  {
58  $moduleNamesAndLabels = self::findGlobalSearchScopingModuleNamesAndLabelsDataByUser($user);
59  GeneralCache::cacheEntry(self::getGlobalSearchScopingCacheIdentifier($user), $moduleNamesAndLabels);
60  return $moduleNamesAndLabels;
61  }
62  }
63 
64  protected static function findGlobalSearchScopingModuleNamesAndLabelsDataByUser(User $user)
65  {
66  assert('$user->id > 0');
67  $moduleNamesAndLabels = array();
68  $modules = Module::getModuleObjects();
69  foreach ($modules as $module)
70  {
71  $globalSearchFormClassName = $module::getGlobalSearchFormClassName();
73  $globalSearchFormClassName != null && RightsUtil::canUserAccessModule(get_class($module), $user))
74  {
75  $moduleNamesAndLabels[$module->getName()] = $module::getModuleLabelByTypeAndLanguage('Plural');
76  }
77  }
78  return $moduleNamesAndLabels;
79  }
80 
86  protected static function getGlobalSearchScopingCacheIdentifier(User $user)
87  {
88  assert('$user->id > 0');
89  return 'GlobalSearchScopingModuleNamesAndLabels' . $user->id . Yii::app()->language;
90  }
91 
97  public static function resolveModuleNamesAndLabelsDataWithAllOption(& $moduleNamesAndLabels)
98  {
99  $moduleNamesAndLabels = array_merge(array('All' => Zurmo::t('Core', 'All')), $moduleNamesAndLabels);
100  }
101 
109  public static function resolveGlobalSearchScopeFromGetData($get, $attributeName = 'globalSearchScope')
110  {
111  assert('is_string($attributeName)');
112  if (!isset($get[$attributeName]) || in_array('All', $get[$attributeName]))
113  {
114  return null;
115  }
116  else
117  {
118  return $get[$attributeName];
119  }
120  }
121 
129  public static function resolveIfModuleShouldBeGloballySearched(Module $module)
130  {
131  if ($module::modelsAreNeverGloballySearched())
132  {
133  return false;
134  }
135  return true;
136  }
137  }
138 ?>
static resolveIfModuleShouldBeGloballySearched(Module $module)
static resolveGlobalSearchScopeFromGetData($get, $attributeName= 'globalSearchScope')
Definition: User.php:37
static getModuleObjects()
Definition: Module.php:51
static getGlobalSearchScopingModuleNamesAndLabelsDataByUser(User $user)
static canUserAccessModule($moduleClassName, $user)
Definition: RightsUtil.php:103
static getGlobalSearchScopingCacheIdentifier(User $user)
static resolveModuleNamesAndLabelsDataWithAllOption(&$moduleNamesAndLabels)
Generated on Thu May 28 2020 07:10:36