Document MySQL error codes

[BenMorel]

Q	A
Type	improvement
BC Break	no
Fixed issues	none

Summary

Documents mysql error codes for easier reading.

References:

• https://dev.mysql.com/doc/refman/5.7/en/server-error-reference.html
• https://dev.mysql.com/doc/refman/5.7/en/client-error-reference.html

[BenMorel]

Not sure how to fix the phpcs issue:

• when I don't put an empty line before the return statement, I get:

Expected 1 lines before "return", found 0.

• when I do put an empty line before it, I get:

The CASE body must start on the line following the statement

This contradiction only occurs when a comment is on the same line as the case.

[morozov]

Why not define the codes as constants instead of comments?

[BenMorel]

It's a possibility, it just adds a bit of burden for something that's not going to be reused anywhere IMHO.

If you wish to proceed this way, please tell me where they should go:

• as constants in the AbstractMySQLDriver class
• or as constants in the Doctrine\DBAL\Driver namespace (and in which file then?)

[lcobucci]

@BenMorel I'd suggest private constants in AbstractMySQLDriver.

[BenMorel]

Here you are!

[morozov]

It's a possibility, it just adds a bit of burden for something that's not going to be reused anywhere IMHO.

It's not about reuse. It's about self-documenting code.

Here you are!

Thank you.

Could you please also move the @link annotations from convertException() to the group block around the newly declared constants like here?

dbal/lib/Doctrine/DBAL/SQLParserUtils.php

Lines 34 to 42 in c104c68

	/**#@+
	* Quote characters within string literals can be preceded by a backslash.
	*
	* @deprecated Will be removed as internal implementation details.
	*/
	public const ESCAPED_SINGLE_QUOTED_TEXT = "(?:'(?:\\\\)+'|'(?:[^'\\\\]|\\\\'?|'')*')";
	public const ESCAPED_DOUBLE_QUOTED_TEXT = '(?:"(?:\\\\)+"|"(?:[^"\\\\]|\\\\"?)*")';
	public const ESCAPED_BACKTICK_QUOTED_TEXT = '(?:`(?:\\\\)+`|`(?:[^`\\\\]|\\\\`?)*`)';
	/**#@-*/

And then squash.

[BenMorel]

Is this /**#@+ ... */ ... /**#@-*/ a PHPdoc standard of some sort? I've never come across this one.

[morozov]

Is this /**#@+ ... */ ... /**#@-*/ a PHPdoc standard of some sort? I've never come across this one.

This is/was actively used in PEAR, athough I'm not sure if it's part of the phpDoc standard.

UPD: it's called a DocBlock template.

[BenMorel]

@morozov All done!

[morozov]

Thanks @BenMorel! 🚢