Development talk:Coding style - Revision history

TimHunt: /* Formatting arrays */

2011-01-28T16:30:04Z

Formatting arrays

← Older revision		Revision as of 16:30, 28 January 2011
Line 245:		Line 245:

	--[[User:Helen Foster\|Helen Foster]] 14:06, 28 January 2011 (UTC)		--[[User:Helen Foster\|Helen Foster]] 14:06, 28 January 2011 (UTC)

			: Acutally, Martin chose to do arrays like that. You can argue that it is inconsistent, but actually it looks nice, so I like it the way it currently is in Coding style.--[[User:Tim Hunt\|Tim Hunt]] 16:30, 28 January 2011 (UTC)

Tsala: Formatting arrays

2011-01-28T14:06:06Z

Formatting arrays

← Older revision		Revision as of 14:06, 28 January 2011
Line 234:		Line 234:

	$DB->get_record_sql("SELECT * FROM {$CFG->prefix}course WHERE id <> ?', array($exceptid));		$DB->get_record_sql("SELECT * FROM {$CFG->prefix}course WHERE id <> ?', array($exceptid));

			==Formatting arrays==

			As reported by Tomasz Muras in MDLSITE-1187:

			* have a look at section https://docs.moodle.org/en/Development:Coding_style#Wrapping_Arrays that describes multi-line associate arrays
			* update https://docs.moodle.org/en/Development:Coding_style#Associative_arrays :
			** the indentation should be 8 spaces (not 4)
			** put closing bracket and semicolon ); at the end of previous line 'secondkey' => 'secondvalue' to make it consistent

			--[[User:Helen Foster\|Helen Foster]] 14:06, 28 January 2011 (UTC)

Nakohdo: /* Database code */

2011-01-14T10:54:50Z

Database code

← Older revision		Revision as of 10:54, 14 January 2011
Line 194:		Line 194:

	I would suggest the following database coding guidelines		I would suggest the following database coding guidelines
			: Linked to [[Development:Developer_FAQ#How_do_I_insert.2Fretrieve_records_in_the_database.2C_without_creating_my_own_database_connections.3F]] --[[User:Frank Ralf\|Frank Ralf]] 10:54, 14 January 2011 (UTC)


	=== Database code using SQL ===		=== Database code using SQL ===

Nakohdo: /* Database code using SQL */

2011-01-14T07:44:02Z

Database code using SQL

← Older revision		Revision as of 07:44, 14 January 2011
Line 195:		Line 195:
	I would suggest the following database coding guidelines		I would suggest the following database coding guidelines

	== Database code using SQL ==		=== Database code using SQL ===

	* Where possible, use the plain get_records, get_recordset, etc functions instead of the _sql variants.		* Where possible, use the plain get_records, get_recordset, etc functions instead of the _sql variants.

Nakohdo: /* Database code using SQL */ cosmetic changes

2011-01-14T07:43:12Z

Database code using SQL: cosmetic changes

← Older revision		Revision as of 07:43, 14 January 2011
Line 199:		Line 199:
	* Where possible, use the plain get_records, get_recordset, etc functions instead of the _sql variants.		* Where possible, use the plain get_records, get_recordset, etc functions instead of the _sql variants.

	Correct:		; Correct:

			<code php>
	$DB->get_record('course', array('id' => $id));		$DB->get_record('course', array('id' => $id));
			</code>

	Wrong:		; Wrong:

	$DB->get_record_sql('SELECT * FROM {course} WHERE id=?', array($id));		$DB->get_record_sql('SELECT * FROM {course} WHERE id=?', array($id));
Line 209:		Line 211:
	* When using SQL code, do not add variable parameters directly into the string. Instead, use the new methods for including parameters.		* When using SQL code, do not add variable parameters directly into the string. Instead, use the new methods for including parameters.

	Correct:		; Correct:
			<code php>
	$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));		$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));
			</code>

	Wrong:		; Wrong:

	$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ' . $exceptid);		$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ' . $exceptid);
Line 221:		Line 224:
	* When using SQL code, do not use the $CFG->prefix variable. Instead use the new {tablename} syntax.		* When using SQL code, do not use the $CFG->prefix variable. Instead use the new {tablename} syntax.

	Correct:		; Correct:
			<code php>
	$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));		$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));
			</code>

	Wrong:		; Wrong:

	$DB->get_record_sql("SELECT * FROM {$CFG->prefix}course WHERE id <> ?', array($exceptid));		$DB->get_record_sql("SELECT * FROM {$CFG->prefix}course WHERE id <> ?', array($exceptid));

Quen: /* Database code */ new section

2011-01-13T17:46:01Z

Database code: new section

← Older revision		Revision as of 17:46, 13 January 2011
Line 190:		Line 190:

	There. The BAD code is now not so bad after all. [[User:jfine]] 00:76, 1 Aug 2010 (UTC)		There. The BAD code is now not so bad after all. [[User:jfine]] 00:76, 1 Aug 2010 (UTC)

			== Database code ==

			I would suggest the following database coding guidelines

			== Database code using SQL ==

			* Where possible, use the plain get_records, get_recordset, etc functions instead of the _sql variants.

			Correct:

			$DB->get_record('course', array('id' => $id));

			Wrong:

			$DB->get_record_sql('SELECT * FROM {course} WHERE id=?', array($id));

			* When using SQL code, do not add variable parameters directly into the string. Instead, use the new methods for including parameters.

			Correct:

			$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));

			Wrong:

			$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ' . $exceptid);

			(Using parameters properly avoids possible serious security holes.)

			* When using SQL code, do not use the $CFG->prefix variable. Instead use the new {tablename} syntax.

			Correct:

			$DB->get_record_sql('SELECT * FROM {course} WHERE id <> ?', array($exceptid));

			Wrong:

			$DB->get_record_sql("SELECT * FROM {$CFG->prefix}course WHERE id <> ?', array($exceptid));

Jfine: /* Sensible temporaries */

2010-08-01T18:47:41Z

Sensible temporaries

← Older revision		Revision as of 18:47, 1 August 2010
Line 189:		Line 189:
	</code>		</code>

	There. The BAD code is now not so bad after all.		There. The BAD code is now not so bad after all. [[User:jfine]] 00:76, 1 Aug 2010 (UTC)

Jfine: Add "Sensible temporaries".

2010-08-01T18:46:06Z

Add "Sensible temporaries".

← Older revision		Revision as of 18:46, 1 August 2010
Line 177:		Line 177:

	[[User:jfine]] 7.35, 1 Aug 2010 (UTC)		[[User:jfine]] 7.35, 1 Aug 2010 (UTC)

			== Sensible temporaries ==

			Here's some code thought to be BAD, improved with temporaries (and a probably trivial change of meaning).
			<code php>
			$eo = element['object'];
			$eog = $eo->gradetype;

			if (($eo->is_course_item() or $eo->is_category_item())
			and ($eog == GRADE_TYPE_SCALE or $eog == GRADE_TYPE_VALUE)) {
			</code>

			There. The BAD code is now not so bad after all.

Jfine: Add discuss "Wrapping control structures"

2010-08-01T18:40:05Z

Add discuss "Wrapping control structures"

← Older revision		Revision as of 18:40, 1 August 2010
Line 144:		Line 144:

	I just updated the bit about @package names, following discussion and a clear consensus with Petr: http://moodle.org/mod/cvsadmin/view.php?conversationid=4294.--[[User:Tim Hunt\|Tim Hunt]] 10:47, 3 March 2010 (UTC)		I just updated the bit about @package names, following discussion and a clear consensus with Petr: http://moodle.org/mod/cvsadmin/view.php?conversationid=4294.--[[User:Tim Hunt\|Tim Hunt]] 10:47, 3 March 2010 (UTC)

			== Wrapping Control Structures ==

			The example given suggests that:
			<code php>
			if (f() and g()) {

			}
			</code>
			is equivalent to:
			<code php>
			$tmp1 = f();
			$tmp2 = g();
			if ($tmp1 and $tmp2){

			}
			</code>

			But in the former g() is evaluated only if f() returns a value that is true (in a boolean context).

			I suggest something like

			BETTER GOOD:
			<code php>
			$coursecategory = $element['object']->is_course_item() or $element['object']->is_category_item();
			if ($coursecategory) {
			$scalevalue = in_array($element['object']->gradetype, array(GRADE_TYPE_SCALE, GRADE_TYPE_VALUE));
			if ($scalevalue){
			</code>

			I also suggest that the code fragments in GOOD and BAD be made to agree in the rest of the logic. (GOOD has form ((a or b) and c) while BAD has form ((a or b) and (c or d)).

			[[User:jfine]] 7.35, 1 Aug 2010 (UTC)

TimHunt: /* File comments */

2010-03-03T10:47:32Z

File comments

← Older revision		Revision as of 10:47, 3 March 2010
Line 142:		Line 142:

	:: Ah, fair enough. I was forgetting that the purpose of that like was just to make the copyright owner clear. I completely agree with you about not duplicating information in CVS.--[[User:Tim Hunt\|Tim Hunt]] 08:37, 5 October 2009 (UTC)		:: Ah, fair enough. I was forgetting that the purpose of that like was just to make the copyright owner clear. I completely agree with you about not duplicating information in CVS.--[[User:Tim Hunt\|Tim Hunt]] 08:37, 5 October 2009 (UTC)

			I just updated the bit about @package names, following discussion and a clear consensus with Petr: http://moodle.org/mod/cvsadmin/view.php?conversationid=4294.--[[User:Tim Hunt\|Tim Hunt]] 10:47, 3 March 2010 (UTC)