ArrayDeclaration #

Ensures that arrays conform to the array coding standard.

Scope #

Squiz.Arrays.ArrayDeclaration

Description #

This standard covers all array declarations, regardless of the number and type of values contained within the array.

The <em>array</em> keyword must be lowercase.

The first array key must begin on the line after the <em>array</em> keyword.

All array keys must be indented to one space after the start of the <em>array</em> keyword. The closing parenthesis must be aligned with the start of the <em>array</em> keyword.

All double arrow symbols must be aligned to one space after the longest array key. Alignment must be achieved using spaces.

All array values must be followed by a comma, including the final value.

Usage #

<rule ref="Squiz.Arrays.ArrayDeclaration"></rule>

Examples #

Example 1 #

$array = array('val1', 'val2');

$array = Array('val1', 'val2');

Example 2 #

$array = array(
          'key1' => 'value1',
          'key2' => 'value2',
         );

$array = array('key1' => 'value1',
          'key2' => 'value2',
         );

Example 3 #

$array = array(
          'key1' => 'value1',
          'key2' => 'value2',
         );

$array = array(
         'key1' => 'value1',
         'key2' => 'value2',
);

Example 4 #

$array = array(
          'keyTen'    => 'ValueTen',
          'keyTwenty' => 'ValueTwenty',
         );

$array = array(
          'keyTen' => 'ValueTen',
          'keyTwenty' => 'ValueTwenty',
         );

Example 5 #

$array = array(
          'key1' => 'value1',
          'key2' => 'value2',
          'key3' => 'value3',
         );

$array = array(
          'key1' => 'value1',
          'key2' => 'value2',
          'key3' => 'value3' 
         );