Admin Control Panel v2.0

✎ Editing: ArrayDeclarationStandard.xml ← Back

<documentation title="Array Declarations">
 <standard>
 <![CDATA[
 This standard covers all array declarations, regardless of the number and type of values contained within the array.
 ]]>
 </standard>
 <standard>
 <![CDATA[
 The array keyword must be lowercase.
 ]]>
 </standard>
 <code_comparison>
 <code title="Valid: Array keyword lowercase.">
 <![CDATA[
$array = array('val1', 'val2');
 ]]>
 </code>
 <code title="Invalid: First letter capitalised.">
 <![CDATA[
$array = Array('val1', 'val2');
 ]]>
 </code>
 </code_comparison>
 <standard>
 <![CDATA[
 The first array key must begin on the line after the array keyword.
 ]]>
 </standard>
 <code_comparison>
 <code title="Valid: First key on second line.">
 <![CDATA[
$array = array(
 'key1' => 'value1',
 'key2' => 'value2',
 );
 ]]>
 </code>
 <code title="Invalid: First key on same line.">
 <![CDATA[
$array = array('key1' => 'value1',
 'key2' => 'value2',
 );
 ]]>
 </code>
 </code_comparison>
 <standard>
 <![CDATA[
 All array keys must be indented to one space after the start of the array keyword. The closing parenthesis must be aligned with the start of the array keyword.
 ]]>
 </standard>
 <code_comparison>
 <code title="Valid: Aligned correctly.">
 <![CDATA[
$array = array(
 'key1' => 'value1',
 'key2' => 'value2',
 );
 ]]>
 </code>
 <code title="Invalid: Keys and parenthesis aligned incorrectly.">
 <![CDATA[
$array = array(
 'key1' => 'value1',
 'key2' => 'value2',
);
 ]]>
 </code>
 </code_comparison>
 <standard>
 <![CDATA[
 All double arrow symbols must be aligned to one space after the longest array key. Alignment must be achieved using spaces.
 ]]>
 </standard>
 <code_comparison>
 <code title="Valid: Keys and values aligned.">
 <![CDATA[
$array = array(
 'keyTen' => 'ValueTen',
 'keyTwenty' => 'ValueTwenty',
 );
 ]]>
 </code>
 <code title="Invalid: Alignment incorrect.">
 <![CDATA[
$array = array(
 'keyTen' => 'ValueTen',
 'keyTwenty' => 'ValueTwenty',
 );
 ]]>
 </code>
 </code_comparison>
 <standard>
 <![CDATA[
 All array values must be followed by a comma, including the final value.
 ]]>
 </standard>
 <code_comparison>
 <code title="Valid: Comma after each value.">
 <![CDATA[
$array = array(
 'key1' => 'value1',
 'key2' => 'value2',
 'key3' => 'value3',
 );
 ]]>
 </code>
 <code title="Invalid: No comma after last value.">
 <![CDATA[
$array = array(
 'key1' => 'value1',
 'key2' => 'value2',
 'key3' => 'value3' 
 );
 ]]>
 </code>
 </code_comparison>
</documentation>

Cancel