Skip to content
This repository was archived by the owner on Jan 21, 2020. It is now read-only.

Double quote usage #18

Closed
wants to merge 3 commits into from
Closed

Double quote usage #18

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7850452
Clarified usage of double quotes to match examples, added spaces to s…
mattkynaston Apr 29, 2019
6f2c03e
Excluded Squiz.Strings.DoubleQuoteUsage.ContainsVar
mattkynaston Apr 30, 2019
b95be20
Updated docs and added tests
mattkynaston May 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/book/v2/ruleset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,25 +953,26 @@ Force whitespace before and after concatenation

### Squiz.Strings.DoubleQuoteUsage
#### Squiz.Strings.DoubleQuoteUsage.ContainsVar
Double quote strings may only be used if they contain variables. SQL queries containing single quotes are an exception
Double quote strings may only be used if they contain variables, control characters or if using single quotes would
result in more escaped characters than necessary. For instance, SQL queries containing single quotes are an exception
to the rule.

*Valid: Double quote strings are only used when it contains a variable.*
*Valid: Double quote strings are only used when it contains a variable, control characters or single quotes.*
```php
<?php
$string = "Hello There\r\n";
$string = "Hello $there";
$string = 'Hello There';
$string = 'Hello'.' There'."\n";
$string = 'Hello' . ' There' . "\n";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should remove this example as interpolation would be better. In this case it would end up the same as the first example: "Hello There\n";

$string = '\$var';
$query = "SELECT * FROM table WHERE name =''";
```

*Invalid: There are no variables inside double quote strings.*
*Invalid: There are no variables, control characters inside double quote strings*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to: "Invalid: There are no variables or control characters inside double quote strings."

```php
<?php
$string = "Hello There";
$string = "Hello"." There"."\n";
$string = "Hello" . " There" . "\n";
$string = "\$var";
```

Expand Down
5 changes: 2 additions & 3 deletions src/ZendCodingStandard/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,8 @@
</properties>
</rule>
<!-- Forbid strings in `"` unless necessary -->
<rule ref="Squiz.Strings.DoubleQuoteUsage"/>
<rule ref="Squiz.Strings.DoubleQuoteUsage.ContainsVar">
<message>Variable "%s" not allowed in double quoted string; use sprintf() or concatenation instead</message>
<rule ref="Squiz.Strings.DoubleQuoteUsage">
<exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"></exclude>
</rule>
<!-- Forbid braces around string in `echo` -->
<rule ref="Squiz.Strings.EchoedStrings"/>
Expand Down