installHelp.php ➔ help_step_1_html() - Code Metrics - adamjakab/SuiteCRM - Measure and Improve Code Quality continuously with Scrutinizer

installHelp.php ➔ help_step_1_html() A
last analyzed 2016-05-10 08:39 UTC

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	49
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Metric	Value
cc	1
eloc	34
nc	1
nop	0
dl	0
loc	49
ccs	0
cts	38
cp	0
crap	2
rs	9.2258

<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
/*********************************************************************************
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.

 * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
 * Copyright (C) 2011 - 2014 Salesagility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for  technical reasons, the Appropriate Legal Notices must
 * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 ********************************************************************************/



class HelpItem {
   var $associated_field = '';
   var $title = '';
   var $text = '';
}

function &help_menu_html() {
   $str =<<<HEREDOC_END
		<div>SugarCRM Install Help</div>
		<ul>
		<li><a href="$_SERVER[PHP_SELF]?step=1">Step 1: Prerequisite checks</a></li>
		<li><a href="$_SERVER[PHP_SELF]?step=2">Step 2: Database configuration</a></li>
		<li><a href="$_SERVER[PHP_SELF]?step=3">Step 3: Site configuration</a></li>
		<li><a href="$_SERVER[PHP_SELF]?step=4">Step 4: Saving config file and setting up the database</a></li>
		<li><a href="$_SERVER[PHP_SELF]?step=5">Step 5: Registration</a></li>
		</ul>
HEREDOC_END;
   return $str;
}

function &format_help_items(&$help_items)
{
   $str = '<table>';

   foreach($help_items as $help_item)
   {
      $str .= <<< HEREDOC_END
<tr><td><b>$help_item->title</b></td></tr>
<tr><td>$help_item->text</td></tr>
HEREDOC_END;
   }

   $str .= '</table>';

   return $str;
}

function &help_step_1_html()
{
   $help_items = array();

   $help_item = new HelpItem();
   $help_item->title = 'PHP Version';
   $help_item->text = <<< HEREDOC_END
The version of PHP installed must be 4.3.x or 5.x.
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'MySQL Database';
   $help_item->text = <<< HEREDOC_END
Checking that the MySQL API is accessible.
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'SugarCRM Configuration File';
   $help_item->text = <<< HEREDOC_END
The configuration file (config.php) must be writable.
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Cache Sub-Directories';
   $help_item->text = <<< HEREDOC_END
All the sub-directories beneath the cache directory (cache) must be
writable.
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Session Save Path';
   $help_item->text = <<< HEREDOC_END
The session save path specified in the PHP initialization file (php.ini)
as session_save_path must exist and be writable.
HEREDOC_END;

   $help_items[] = $help_item;

   $str =format_help_items($help_items);
   return $str;
}

function &help_step_2_html()
{
   $help_items = array();

   $help_item = new HelpItem();
   $help_item->title = 'Host Name';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Database Name';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Create Database';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'User Name for SugarCRM';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Create User';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Password for SugarCRM';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Re-Type Password for SugarCRM';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Drop and recreate existing SugarCRM tables?';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Populate database with demo data?';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Database Admin User Name';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Database Admin Password';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $str =format_help_items($help_items);
   return $str;
}

function &help_step_3_html()
{
   $help_items = array();

   $help_item = new HelpItem();
   $help_item->title = 'URL';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'SugarCRM Admin Password';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Re-type SugarCRM Admin Password';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Allow SugarCRM to collect anonymous usage information?';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Use a Custom Session Directory for SugarCRM';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Path to Session Directory';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Provide Your Own Application ID';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $help_item = new HelpItem();
   $help_item->title = 'Application ID';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $str =format_help_items($help_items);
   return $str;
}

function &help_step_4_html()
{
   $help_items = array();

   $help_item = new HelpItem();
   $help_item->title = 'Perform Install';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $str =format_help_items($help_items);
   return $str;
}

function &help_step_5_html()
{
   $help_items = array();

   $help_item = new HelpItem();
   $help_item->title = 'Registration';
   $help_item->text = <<< HEREDOC_END
TODO
HEREDOC_END;

   $help_items[] = $help_item;

   $str =format_help_items($help_items);
   return $str;
}

?>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html <?php get_language_header(); ?>>

<head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   <meta http-equiv="Content-Style-Type" content="text/css">
   <title>SugarCRM Install Help</title>
   <link rel="stylesheet" href="install/install.css" type="text/css" />
</head>
<body>
<?php
if(isset($_GET['step']))
{
   switch($_GET['step'])
   {
      case 1:
         echo help_step_1_html();
      break;
      case 2:
         echo help_step_2_html();
      break;
      case 3:
         echo help_step_3_html();
      break;
      case 4:
         echo help_step_4_html();
      break;
      case 5:
         echo help_step_5_html();
      break;
      default:
         echo help_menu_html();
      break;
   }
}
else
{
   echo help_menu_html();
}
?>

<form>
   <input type="button" value="Close" onclick="javascript:window.close();" />
</form>
</body>
</html>


1			<?php
2			if(!defined('sugarEntry') \|\| !sugarEntry) die('Not A Valid Entry Point');
3			/*********************************************************************************
4			* SugarCRM Community Edition is a customer relationship management program developed by
5			* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
6
7			* SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
8			* Copyright (C) 2011 - 2014 Salesagility Ltd.
9			*
10			* This program is free software; you can redistribute it and/or modify it under
11			* the terms of the GNU Affero General Public License version 3 as published by the
12			* Free Software Foundation with the addition of the following permission added
13			* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
14			* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
15			* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
16			*
17			* This program is distributed in the hope that it will be useful, but WITHOUT
18			* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19			* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
20			* details.
21			*
22			* You should have received a copy of the GNU Affero General Public License along with
23			* this program; if not, see http://www.gnu.org/licenses or write to the Free
24			* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25			* 02110-1301 USA.
26			*
27			* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
28			* SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
29			*
30			* The interactive user interfaces in modified source and object code versions
31			* of this program must display Appropriate Legal Notices, as required under
32			* Section 5 of the GNU Affero General Public License version 3.
33			*
34			* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
35			* these Appropriate Legal Notices must retain the display of the "Powered by
36			* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
37			* reasonably feasible for technical reasons, the Appropriate Legal Notices must
38			* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
39			********************************************************************************/
40
41
42
43			class HelpItem {
44			var $associated_field = '';
45			var $title = '';
46			var $text = '';
47			}
48
49			function &help_menu_html() {
50			$str =<<<HEREDOC_END
51			<div>SugarCRM Install Help</div>
52			<ul>
53			<li><a href="$_SERVER[PHP_SELF]?step=1">Step 1: Prerequisite checks</a></li>
54			<li><a href="$_SERVER[PHP_SELF]?step=2">Step 2: Database configuration</a></li>
55			<li><a href="$_SERVER[PHP_SELF]?step=3">Step 3: Site configuration</a></li>
56			<li><a href="$_SERVER[PHP_SELF]?step=4">Step 4: Saving config file and setting up the database</a></li>
57			<li><a href="$_SERVER[PHP_SELF]?step=5">Step 5: Registration</a></li>
58			</ul>
59			HEREDOC_END;
60			return $str;
61			}
62
63			function &format_help_items(&$help_items)
64			{
65			$str = '<table>';
66
67			foreach($help_items as $help_item)
68			{
69			$str .= <<< HEREDOC_END
70			<tr><td><b>$help_item->title</b></td></tr>
71			<tr><td>$help_item->text</td></tr>
72			HEREDOC_END;
73			}
74
75			$str .= '</table>';
76
77			return $str;
78			}
79
80			function &help_step_1_html()
81			{
82			$help_items = array();
83
84			$help_item = new HelpItem();
85			$help_item->title = 'PHP Version';
86			$help_item->text = <<< HEREDOC_END
87			The version of PHP installed must be 4.3.x or 5.x.
88			HEREDOC_END;
89
90			$help_items[] = $help_item;
91
92			$help_item = new HelpItem();
93			$help_item->title = 'MySQL Database';
94			$help_item->text = <<< HEREDOC_END
95			Checking that the MySQL API is accessible.
96			HEREDOC_END;
97
98			$help_items[] = $help_item;
99
100			$help_item = new HelpItem();
101			$help_item->title = 'SugarCRM Configuration File';
102			$help_item->text = <<< HEREDOC_END
103			The configuration file (config.php) must be writable.
104			HEREDOC_END;
105
106			$help_items[] = $help_item;
107
108			$help_item = new HelpItem();
109			$help_item->title = 'Cache Sub-Directories';
110			$help_item->text = <<< HEREDOC_END
111			All the sub-directories beneath the cache directory (cache) must be
112			writable.
113			HEREDOC_END;
114
115			$help_items[] = $help_item;
116
117			$help_item = new HelpItem();
118			$help_item->title = 'Session Save Path';
119			$help_item->text = <<< HEREDOC_END
120			The session save path specified in the PHP initialization file (php.ini)
121			as session_save_path must exist and be writable.
122			HEREDOC_END;
123
124			$help_items[] = $help_item;
125
126			$str =format_help_items($help_items);
127			return $str;
128			}
129
130			function &help_step_2_html()
131			{
132			$help_items = array();
133
134			$help_item = new HelpItem();
135			$help_item->title = 'Host Name';
136			$help_item->text = <<< HEREDOC_END
137			TODO
138			HEREDOC_END;
139
140			$help_items[] = $help_item;
141
142			$help_item = new HelpItem();
143			$help_item->title = 'Database Name';
144			$help_item->text = <<< HEREDOC_END
145			TODO
146			HEREDOC_END;
147
148			$help_items[] = $help_item;
149
150			$help_item = new HelpItem();
151			$help_item->title = 'Create Database';
152			$help_item->text = <<< HEREDOC_END
153			TODO
154			HEREDOC_END;
155
156			$help_items[] = $help_item;
157
158			$help_item = new HelpItem();
159			$help_item->title = 'User Name for SugarCRM';
160			$help_item->text = <<< HEREDOC_END
161			TODO
162			HEREDOC_END;
163
164			$help_items[] = $help_item;
165
166			$help_item = new HelpItem();
167			$help_item->title = 'Create User';
168			$help_item->text = <<< HEREDOC_END
169			TODO
170			HEREDOC_END;
171
172			$help_items[] = $help_item;
173
174			$help_item = new HelpItem();
175			$help_item->title = 'Password for SugarCRM';
176			$help_item->text = <<< HEREDOC_END
177			TODO
178			HEREDOC_END;
179
180			$help_items[] = $help_item;
181
182			$help_item = new HelpItem();
183			$help_item->title = 'Re-Type Password for SugarCRM';
184			$help_item->text = <<< HEREDOC_END
185			TODO
186			HEREDOC_END;
187
188			$help_items[] = $help_item;
189
190			$help_item = new HelpItem();
191			$help_item->title = 'Drop and recreate existing SugarCRM tables?';
192			$help_item->text = <<< HEREDOC_END
193			TODO
194			HEREDOC_END;
195
196			$help_items[] = $help_item;
197
198			$help_item = new HelpItem();
199			$help_item->title = 'Populate database with demo data?';
200			$help_item->text = <<< HEREDOC_END
201			TODO
202			HEREDOC_END;
203
204			$help_items[] = $help_item;
205
206			$help_item = new HelpItem();
207			$help_item->title = 'Database Admin User Name';
208			$help_item->text = <<< HEREDOC_END
209			TODO
210			HEREDOC_END;
211
212			$help_items[] = $help_item;
213
214			$help_item = new HelpItem();
215			$help_item->title = 'Database Admin Password';
216			$help_item->text = <<< HEREDOC_END
217			TODO
218			HEREDOC_END;
219
220			$help_items[] = $help_item;
221
222			$str =format_help_items($help_items);
223			return $str;
224			}
225
226			function &help_step_3_html()
227			{
228			$help_items = array();
229
230			$help_item = new HelpItem();
231			$help_item->title = 'URL';
232			$help_item->text = <<< HEREDOC_END
233			TODO
234			HEREDOC_END;
235
236			$help_items[] = $help_item;
237
238			$help_item = new HelpItem();
239			$help_item->title = 'SugarCRM Admin Password';
240			$help_item->text = <<< HEREDOC_END
241			TODO
242			HEREDOC_END;
243
244			$help_items[] = $help_item;
245
246			$help_item = new HelpItem();
247			$help_item->title = 'Re-type SugarCRM Admin Password';
248			$help_item->text = <<< HEREDOC_END
249			TODO
250			HEREDOC_END;
251
252			$help_items[] = $help_item;
253
254			$help_item = new HelpItem();
255			$help_item->title = 'Allow SugarCRM to collect anonymous usage information?';
256			$help_item->text = <<< HEREDOC_END
257			TODO
258			HEREDOC_END;
259
260			$help_items[] = $help_item;
261
262			$help_item = new HelpItem();
263			$help_item->title = 'Use a Custom Session Directory for SugarCRM';
264			$help_item->text = <<< HEREDOC_END
265			TODO
266			HEREDOC_END;
267
268			$help_items[] = $help_item;
269
270			$help_item = new HelpItem();
271			$help_item->title = 'Path to Session Directory';
272			$help_item->text = <<< HEREDOC_END
273			TODO
274			HEREDOC_END;
275
276			$help_items[] = $help_item;
277
278			$help_item = new HelpItem();
279			$help_item->title = 'Provide Your Own Application ID';
280			$help_item->text = <<< HEREDOC_END
281			TODO
282			HEREDOC_END;
283
284			$help_items[] = $help_item;
285
286			$help_item = new HelpItem();
287			$help_item->title = 'Application ID';
288			$help_item->text = <<< HEREDOC_END
289			TODO
290			HEREDOC_END;
291
292			$help_items[] = $help_item;
293
294			$str =format_help_items($help_items);
295			return $str;
296			}
297
298			function &help_step_4_html()
299			{
300			$help_items = array();
301
302			$help_item = new HelpItem();
303			$help_item->title = 'Perform Install';
304			$help_item->text = <<< HEREDOC_END
305			TODO
306			HEREDOC_END;
307
308			$help_items[] = $help_item;
309
310			$str =format_help_items($help_items);
311			return $str;
312			}
313
314			function &help_step_5_html()
315			{
316			$help_items = array();
317
318			$help_item = new HelpItem();
319			$help_item->title = 'Registration';
320			$help_item->text = <<< HEREDOC_END
321			TODO
322			HEREDOC_END;
323
324			$help_items[] = $help_item;
325
326			$str =format_help_items($help_items);
327			return $str;
328			}
329
330			?>
331
332			<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
333			<html <?php get_language_header(); ?>>
			0 ignored issues – show Unused Code introduced 2016-03-07 17:58 UTC by Report Bug Copy Issue Report The call to the function `get_language_header()` seems unnecessary as the function has no side-effects. Loading history...
334			<head>
335			<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
336			<meta http-equiv="Content-Style-Type" content="text/css">
337			<title>SugarCRM Install Help</title>
338			<link rel="stylesheet" href="install/install.css" type="text/css" />
339			</head>
340			<body>
341			<?php
342			if(isset($_GET['step']))
343			{
344			switch($_GET['step'])
345			{
346			case 1:
347			echo help_step_1_html();
348			break;
349			case 2:
350			echo help_step_2_html();
351			break;
352			case 3:
353			echo help_step_3_html();
354			break;
355			case 4:
356			echo help_step_4_html();
357			break;
358			case 5:
359			echo help_step_5_html();
360			break;
361			default:
362			echo help_menu_html();
363			break;
364			}
365			}
366			else
367			{
368			echo help_menu_html();
369			}
370			?>
371
372			<form>
373			<input type="button" value="Close" onclick="javascript:window.close();" />
374			</form>
375			</body>
376			</html>
377

adamjakab / SuiteCRM

installHelp.php ➔ help_step_1_html() A last analyzed 2016-05-10 08:39 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

installHelp.php ➔ help_step_1_html() A
last analyzed 2016-05-10 08:39 UTC