class FunctionAliasSniff in Coder 8.3.x

Checks that no PHP function name aliases are used.

@category PHP @package PHP_CodeSniffer @link http://pear.php.net/package/PHP_CodeSniffer

Hierarchy

• class \Drupal\Sniffs\Semantics\FunctionCall implements \PHP_CodeSniffer\Sniffs\Sniff
  • class \Drupal\Sniffs\Semantics\FunctionAliasSniff

File

coder_sniffer/Drupal/Sniffs/Semantics/FunctionAliasSniff.php, line 21

Namespace

Drupal\Sniffs\Semantics

class FunctionAliasSniff extends FunctionCall {

  /**
   * Holds all PHP function name aliases (keys) and originals (values). See
   * http://php.net/manual/en/aliases.php
   *
   * @var array<string, string>
   */
  protected $aliases = [
    '_' => 'gettext',
    'chop' => 'rtrim',
    'close' => 'closedir',
    'com_get' => 'com_propget',
    'com_propset' => 'com_propput',
    'com_set' => 'com_propput',
    'die' => 'exit',
    'diskfreespace' => 'disk_free_space',
    'doubleval' => 'floatval',
    'fbsql' => 'fbsql_db_query',
    'fputs' => 'fwrite',
    'gzputs' => 'gzwrite',
    'i18n_convert' => 'mb_convert_encoding',
    'i18n_discover_encoding' => 'mb_detect_encoding',
    'i18n_http_input' => 'mb_http_input',
    'i18n_http_output' => 'mb_http_output',
    'i18n_internal_encoding' => 'mb_internal_encoding',
    'i18n_ja_jp_hantozen' => 'mb_convert_kana',
    'i18n_mime_header_decode' => 'mb_decode_mimeheader',
    'i18n_mime_header_encode' => 'mb_encode_mimeheader',
    'imap_create' => 'imap_createmailbox',
    'imap_fetchtext' => 'imap_body',
    'imap_getmailboxes' => 'imap_list_full',
    'imap_getsubscribed' => 'imap_lsub_full',
    'imap_header' => 'imap_headerinfo',
    'imap_listmailbox' => 'imap_list',
    'imap_listsubscribed' => 'imap_lsub',
    'imap_rename' => 'imap_renamemailbox',
    'imap_scan' => 'imap_listscan',
    'imap_scanmailbox' => 'imap_listscan',
    'ini_alter' => 'ini_set',
    'is_double' => 'is_float',
    'is_integer' => 'is_int',
    'is_long' => 'is_int',
    'is_real' => 'is_float',
    'is_writeable' => 'is_writable',
    'join' => 'implode',
    'key_exists' => 'array_key_exists',
    'ldap_close' => 'ldap_unbind',
    'magic_quotes_runtime' => 'set_magic_quotes_runtime',
    'mbstrcut' => 'mb_strcut',
    'mbstrlen' => 'mb_strlen',
    'mbstrpos' => 'mb_strpos',
    'mbstrrpos' => 'mb_strrpos',
    'mbsubstr' => 'mb_substr',
    'ming_setcubicthreshold' => 'ming_setCubicThreshold',
    'ming_setscale' => 'ming_setScale',
    'msql' => 'msql_db_query',
    'msql_createdb' => 'msql_create_db',
    'msql_dbname' => 'msql_result',
    'msql_dropdb' => 'msql_drop_db',
    'msql_fieldflags' => 'msql_field_flags',
    'msql_fieldlen' => 'msql_field_len',
    'msql_fieldname' => 'msql_field_name',
    'msql_fieldtable' => 'msql_field_table',
    'msql_fieldtype' => 'msql_field_type',
    'msql_freeresult' => 'msql_free_result',
    'msql_listdbs' => 'msql_list_dbs',
    'msql_listfields' => 'msql_list_fields',
    'msql_listtables' => 'msql_list_tables',
    'msql_numfields' => 'msql_num_fields',
    'msql_numrows' => 'msql_num_rows',
    'msql_regcase' => 'sql_regcase',
    'msql_selectdb' => 'msql_select_db',
    'msql_tablename' => 'msql_result',
    'mssql_affected_rows' => 'sybase_affected_rows',
    'mssql_close' => 'sybase_close',
    'mssql_connect' => 'sybase_connect',
    'mssql_data_seek' => 'sybase_data_seek',
    'mssql_fetch_array' => 'sybase_fetch_array',
    'mssql_fetch_field' => 'sybase_fetch_field',
    'mssql_fetch_object' => 'sybase_fetch_object',
    'mssql_fetch_row' => 'sybase_fetch_row',
    'mssql_field_seek' => 'sybase_field_seek',
    'mssql_free_result' => 'sybase_free_result',
    'mssql_get_last_message' => 'sybase_get_last_message',
    'mssql_min_client_severity' => 'sybase_min_client_severity',
    'mssql_min_error_severity' => 'sybase_min_error_severity',
    'mssql_min_message_severity' => 'sybase_min_message_severity',
    'mssql_min_server_severity' => 'sybase_min_server_severity',
    'mssql_num_fields' => 'sybase_num_fields',
    'mssql_num_rows' => 'sybase_num_rows',
    'mssql_pconnect' => 'sybase_pconnect',
    'mssql_query' => 'sybase_query',
    'mssql_result' => 'sybase_result',
    'mssql_select_db' => 'sybase_select_db',
    'mysql' => 'mysql_db_query',
    'mysql_createdb' => 'mysql_create_db',
    'mysql_db_name' => 'mysql_result',
    'mysql_dbname' => 'mysql_result',
    'mysql_dropdb' => 'mysql_drop_db',
    'mysql_fieldflags' => 'mysql_field_flags',
    'mysql_fieldlen' => 'mysql_field_len',
    'mysql_fieldname' => 'mysql_field_name',
    'mysql_fieldtable' => 'mysql_field_table',
    'mysql_fieldtype' => 'mysql_field_type',
    'mysql_freeresult' => 'mysql_free_result',
    'mysql_listdbs' => 'mysql_list_dbs',
    'mysql_listfields' => 'mysql_list_fields',
    'mysql_listtables' => 'mysql_list_tables',
    'mysql_numfields' => 'mysql_num_fields',
    'mysql_numrows' => 'mysql_num_rows',
    'mysql_selectdb' => 'mysql_select_db',
    'mysql_tablename' => 'mysql_result',
    'oci8append' => 'ocicollappend',
    'oci8assign' => 'ocicollassign',
    'oci8assignelem' => 'ocicollassignelem',
    'oci8close' => 'ocicloselob',
    'oci8free' => 'ocifreedesc',
    'oci8getelem' => 'ocicollgetelem',
    'oci8load' => 'ociloadlob',
    'oci8max' => 'ocicollmax',
    'oci8ocifreecursor' => 'ocifreestatement',
    'oci8save' => 'ocisavelob',
    'oci8savefile' => 'ocisavelobfile',
    'oci8size' => 'ocicollsize',
    'oci8trim' => 'ocicolltrim',
    'oci8writetemporary' => 'ociwritetemporarylob',
    'oci8writetofile' => 'ociwritelobtofile',
    'odbc_do' => 'odbc_exec',
    'odbc_field_precision' => 'odbc_field_len',
    'pdf_add_outline' => 'pdf_add_bookmark',
    'pg_clientencoding' => 'pg_client_encoding',
    'pg_setclientencoding' => 'pg_set_client_encoding',
    'pos' => 'current',
    'recode' => 'recode_string',
    'show_source' => 'highlight_file',
    'sizeof' => 'count',
    'snmpwalkoid' => 'snmprealwalk',
    'strchr' => 'strstr',
    'xptr_new_context' => 'xpath_new_context',
  ];

  /**
   * Returns an array of function names this test wants to listen for.
   *
   * @return array<string>
   */
  public function registerFunctionNames() {
    return array_keys($this->aliases);
  }

  //end registerFunctionNames()

  /**
   * Processes this function call.
   *
   * @param \PHP_CodeSniffer\Files\File $phpcsFile    The file being scanned.
   * @param int                         $stackPtr     The position of the function call in
   *                                                  the stack.
   * @param int                         $openBracket  The position of the opening
   *                                                  parenthesis in the stack.
   * @param int                         $closeBracket The position of the closing
   *                                                  parenthesis in the stack.
   *
   * @return void
   */
  public function processFunctionCall(File $phpcsFile, $stackPtr, $openBracket, $closeBracket) {
    $tokens = $phpcsFile
      ->getTokens();
    $error = '%s() is a function name alias, use %s() instead';
    $name = $tokens[$stackPtr]['content'];
    $data = [
      $name,
      $this->aliases[$name],
    ];
    $phpcsFile
      ->addError($error, $stackPtr, 'FunctionAlias', $data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FunctionAliasSniff::$aliases	protected	property	Holds all PHP function name aliases (keys) and originals (values). See http://php.net/manual/en/aliases.php
FunctionAliasSniff::processFunctionCall	public	function	Processes this function call.
FunctionAliasSniff::registerFunctionNames	public	function	Returns an array of function names this test wants to listen for.
FunctionCall::$arguments	protected	property	Internal cache to save the calculated arguments of the function call.
FunctionCall::$closeBracket	protected	property	The token position of the closing bracket of the function call.
FunctionCall::$functionCall	protected	property	The token position of the function call.
FunctionCall::$includeMethodCalls	protected	property	Whether method invocations with the same function name should be processed, too.	1
FunctionCall::$openBracket	protected	property	The token position of the opening bracket of the function call.
FunctionCall::$phpcsFile	protected	property	The currently processed file.
FunctionCall::getArgument	public	function	Returns start and end token for a given argument number.
FunctionCall::isFunctionCall	protected	function	Checks if this is a function call.
FunctionCall::process	public	function	Processes this test, when one of its tokens is encountered.	2
FunctionCall::register	public	function	Returns an array of tokens this test wants to listen for.