phpcs(1) [debian man page]

phpcs(1)						      General Commands Manual							  phpcs(1)

NAME

       phpcs - php code sniffer cli tool

SYNOPSIS

       phpcs	[-nwlsapvi]    [-d    key[=value]]    [--report=<report>]    [--report-file=<reportfile>]   [--report-<report>=<reportfile>]   ...
       [--report-width=<reportWidth>]  [--generator=<generator>]  [--tab-width=<tabWidth>]  [--severity=<severity>]  [--error-severity=<severity>]
       [--warning-severity=<severity>]	[--config-set key value] [--config-delete key] [--config-show] [--standard=<standard>] [--sniffs=<sniffs>]
       [--encoding=<encoding>] [--extensions=<extensions>] [--ignore=<patterns>] <file> ...

DESCRIPTION

       phpcs (or PHP_CodeSniffer) is a PHP5 script that tokenises PHP, JavaScript and CSS files to detect violations of a defined coding standard.
       It  is  an  essential  development  tool that ensures your code remains clean and consistent. It can also help prevent some common semantic
       errors made by developers.

PARAMETERS

       <file>

	      One or more files and/or directories to check

       <extensions>

	      A comma separated list of file extensions to check (only valid if checking a directory)

       <patterns>

	      A comma separated list of patterns to ignore files and directories

       <encoding>

	      The encoding of the files being checked (default is iso-8859-1)

       <sniffs>

	      A comma separated list of sniff codes to limit the check to (all sniffs must be part of the specified standard)

       <severity>

	      The minimum severity required to display an error or warning

       <standard>

	      The name or path of the coding standard to use

       <tabWidth>

	      The number of spaces each tab represents

       <generator>

	      The name of a doc generator to use (forces doc generation instead of checking)

       <report>

	      Print either the "full", "xml", "checkstyle", "csv", "emacs", "source", "summary", "svnblame", "gitblame" or "hgblame"  report  (the
	      "full" report is printed by default)

       <reportfile>

	      Write the report to the specified file path

       <reportWidth>

	      How many columns wide screen reports should be printed

OPTION

       -n

	      Do not print warnings (shortcut for ---warning-severity=0)

       -w

	      Print both warnings and errors (on by default)

       -l

	      Local directory only, no recursion

       -s

	      Show sniff codes in all reports

       -a

	      Run interactively

       -p

	      Show progress of the run

       -v[v][v]

	      Print verbose output

       -i

	      Show a list of installed coding standards

       -d

	      Set the [key] php.ini value to [value] or [true] if -value is omitted

       --help

	      Print the help message

       --version

	      Print version information

																	  phpcs(1)

addseverity(3C) 					   Standard C Library Functions 					   addseverity(3C)

NAME

       addseverity - build a list of severity levels for an application for use with fmtmsg

SYNOPSIS

       #include <fmtmsg.h>

       int addseverity(int severity, const char *string);

DESCRIPTION

       The  addseverity()  function  builds a list of severity levels for an application to be used with the message formatting facility fmtmsg().
       The severity argument is an integer value indicating the seriousness of the condition. The  string  argument  is  a  pointer  to  a  string
       describing the condition (string is not limited to a specific size).

       If  addseverity() is called with an integer value that has not been previously defined, the function adds that new severity value and print
       string to the existing set of standard severity levels.

       If addseverity() is called with an integer value that has been previously defined, the function redefines that value  with  the	new  print
       string.	Previously  defined severity levels may be removed by supplying the null string. If addseverity() is called with a negative number
       or an integer value of 0, 1, 2, 3, or 4, the function fails and returns -1. The values 0-4 are reserved for the	standard  severity  levels
       and cannot be modified. Identifiers for the standard levels of severity are:

       MM_HALT	     Indicates that the application has encountered a severe fault and is halting. Produces the print string HALT.

       MM_ERROR      Indicates that the application has detected a fault. Produces the print string ERROR.

       MM_WARNING    Indicates	a condition that is out of the ordinary, that might be a problem, and should be watched. Produces the print string
		     WARNING.

       MM_INFO	     Provides information about a condition that is not in error. Produces the print string INFO.

       MM_NOSEV      Indicates that no severity level is supplied for the message.

       Severity levels may also be defined at run time using the SEV_LEVEL environment variable (see fmtmsg(3C)).

RETURN VALUES

       Upon successful completion, addseverity() returns MM_OK. Otherwise it returns MM_NOTOK.

EXAMPLES

       Example 1 Example of addseverity() function.

       When the function call

	 addseverity(7,"ALERT")

       is followed by the call

	 fmtmsg(MM_PRINT, "UX:cat", 7, "invalid syntax", "refer to manual",
	 "UX:cat:001")

       the resulting output is

	 UX:cat: ALERT: invalid syntax
	 TO FIX: refer to manual   UX:cat:001

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       fmtmsg(1), fmtmsg(3C), gettxt(3C), printf(3C), attributes(5)

SunOS 5.11							    29 Dec 1996 						   addseverity(3C)