AC-666: Create phpcs static check for CopyrightTest for php files

[eliseacornejo]

No description provided.

[svera]

Shouldn't we use the Adobe copyright instead?

[eliseacornejo]

I don't know if we should use the Adobe one, @sivaschenko do you know if we can change the copyright to the Adobe one?

[jcuerdo]

This is not working fine. It should be:
if (strpos($contentFile, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound ) {return;}else{addWarning()}

[eliseacornejo]

Done

[sivaschenko]

Great job @eliseacornejo ! Please see my comment.

[sivaschenko]

I would be nice to flatten the code structure for better readability. Also handling the situation when $positionComment is false (no comments found) instantly (not trying to parse it)

Suggested change

	$positionOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, $stackPtr - 1);
	if ($positionOpenTag === false) {
	$positionComment = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
	$contentFile = $phpcsFile->getTokens()[$positionComment]['content'];
	$adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $contentFile);
	if (strpos($contentFile, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
	return;
	} else {
	$phpcsFile->addWarningOnLine(
	'Copyright is missing or has wrong format',
	$phpcsFile->getTokens()[$positionComment]['line'],
	self::WARNING_CODE
	);
	}
	}
	if ($phpcsFile->findPrevious(T_OPEN_TAG, $stackPtr - 1) !== false) {
	return;
	}
	$positionComment = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $stackPtr);
	if ($positionComment === false) {
	$phpcsFile->addWarning(
	'Copyright is missing',
	$stackPtr,
	self::WARNING_CODE
	);
	return;
	}
	$content = $phpcsFile->getTokens()[$positionComment]['content'];
	$adobeCopyrightFound = preg_match(self::COPYRIGHT_ADOBE, $content);
	if (strpos($content, self::COPYRIGHT_MAGENTO_TEXT) !== false || $adobeCopyrightFound) {
	return;
	}
	$phpcsFile->addWarningOnLine(
	'Copyright is missing or has wrong format',
	$phpcsFile->getTokens()[$positionComment]['line'],
	self::WARNING_CODE
	);

[eliseacornejo]

Thanks for your collaboration. Done!

[eliseacornejo]

@magento import pr to magento-commerce/magento-coding-standard

[magento-engcom-team]

@eliseacornejo the pull request successfully imported.

[obukhow]

Could you please modify this sniff to work only for Magento's namespace? We don't need any Adobe or Magento copyright in our code.

[fredden]

@obukhow this is being discussed in #275.