All Data Structures Functions Variables Pages
IntroView.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  abstract class IntroView extends View
42  {
43  protected $moduleName;
44 
48  protected abstract function renderIntroContent();
49 
50  public function __construct($moduleName)
51  {
52  assert('is_string($moduleName)');
53  $this->moduleName = $moduleName;
54  }
55 
59  public function getPanelId()
60  {
61  return get_class($this) . '-intro-content';
62  }
63 
64  public function getModuleName()
65  {
66  return $this->moduleName;
67  }
68 
69  protected function renderContent()
70  {
71  $style = null;
72  if ($this->isIntroViewDismissed())
73  {
74  $style = "style=display:none;"; // Not Coding Standard
75  }
76  $content = "<div id='{$this->getPanelId()}' class='module-intro-content' {$style}>";
77  $content .= $this->renderIntroContent();
78  $content .= $this->renderHideLinkContent();
79  $content .= '</div>';
80  return $content;
81  }
82 
83  protected function renderHideLinkContent()
84  {
85  $label = '<span></span>' . Zurmo::t('ZurmoModule', 'Dismiss');
86  $content = '<div class="hide-module-intro">';
87  $ajaxOptions = array('type' => 'GET',
88  'success' => "function()
89  {
90  $('#{$this->getPanelId()}-checkbox-id').attr('checked', false).parent().removeClass('c_on');
91  $('#{$this->getPanelId()}').slideToggle();
92  }
93  ");
94  $content .= ZurmoHtml::ajaxLink($label,
95  Yii::app()->createUrl('zurmo/default/toggleDismissIntroView',
96  array('moduleName' => $this->moduleName,
97  'panelId' => $this->getPanelId())
98  ),
99  $ajaxOptions);
100  $content .= '</div>';
101  return $content;
102  }
103 
104  public function isIntroViewDismissed()
105  {
106  if (ZurmoConfigurationUtil::getForCurrentUserByModuleName($this->moduleName, $this->getPanelId()))
107  {
108  return true;
109  }
110  return false;
111  }
112 
113  protected function resolveSectionName()
114  {
115  $sectionName = str_replace('link', '', strtolower($this->activeActionElementType));
116  return $sectionName;
117  }
118 
119  protected function registerScripts()
120  {
121  $content = "$(this).resolveHighestAndEqualize($('.module-intro-steps'));";
122  $content .= "$(window).resize(function()
123  {
124  $(this).resolveHighestAndEqualize($('.module-intro-steps'));
125  });";
126  Yii::app()->clientScript->registerScript($this->moduleName, $content);
127  }
128  }
129 ?>
static ajaxLink($text, $url, $ajaxOptions=array(), $htmlOptions=array())
Definition: ZurmoHtml.php:328
renderIntroContent()
Definition: View.php:43
static getForCurrentUserByModuleName($moduleName, $key, $cache=true)
getPanelId()
Definition: IntroView.php:59
Generated on Tue Jan 28 2020 07:10:22