FM / doc

/opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/doc/

/opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/doc

Name	Size	Mode	Actions
arrays.md	1613	0644	edit dl rm
attributes.md	1793	0644	edit dl rm
classes.md	14154	0644	edit dl rm
commenting.md	5860	0644	edit dl rm
complexity.md	288	0644	edit dl rm
control-structures.md	9548	0644	edit dl rm
exceptions.md	1171	0644	edit dl rm
files.md	2601	0644	edit dl rm
functions.md	5337	0644	edit dl rm
namespaces.md	7949	0644	edit dl rm
numbers.md	625	0644	edit dl rm
operators.md	1137	0644	edit dl rm
php.md	3160	0644	edit dl rm
strings.md	392	0644	edit dl rm
type-hints.md	10967	0644	edit dl rm
variables.md	749	0644	edit dl rm
whitespaces.md	623	0644	edit dl rm

Edit: /opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/doc/files.md (2601B)

## Files

#### SlevomatCodingStandard.Files.FileLength

Disallows long files. This sniff provides the following settings:

* `includeComments` (default: `false`): should comments be included in the count.
* `includeWhitespace` (default: `false`): should empty lines be included in the count.
* `maxLinesLength` (default: `250`): specifies max allowed function lines length.

#### SlevomatCodingStandard.Files.LineLength

Enforces maximum length of a single line of code.

Sniff provides the following settings:

* `lineLengthLimit`: actual limit of the line length
* `ignoreComments`: whether to ignore line length of comments
* `ignoreImports`: whether to ignore line length of import (use) statements

#### SlevomatCodingStandard.Files.TypeNameMatchesFileName

For projects not following the [PSR-0](http://www.php-fig.org/psr/psr-0/) or [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading standards, this sniff checks whether a namespace and a name of a class/interface/trait follows agreed-on way to organize code into directories and files.

Other than enforcing that the type name must match the name of the file it's contained in, this sniff is very configurable. Consider the following sample configuration:

```xml
<rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
	<properties>
		<property name="rootNamespaces" type="array">
			<element key="app/ui" value="Slevomat\UI"/>
			<element key="app" value="Slevomat"/>
			<element key="build/SlevomatSniffs/Sniffs" value="SlevomatSniffs\Sniffs"/>
			<element key="tests/ui" value="Slevomat\UI"/>
			<element key="tests" value="Slevomat"/>
		</property>
		<property name="skipDirs" type="array">
			<element value="components"/>
			<element value="forms"/>
			<element value="model"/>
			<element value="models"/>
			<element value="services"/>
			<element value="stubs"/>
			<element value="data"/>
			<element value="new"/>
		</property>
		<property name="ignoredNamespaces" type="array">
			<element value="Slevomat\Services"/>
		</property>
	</properties>
</rule>
```

Sniff provides the following settings:

* `rootNamespaces` property expects configuration similar to PSR-4 - project directories mapped to certain namespaces.
* `skipDirs` are not taken into consideration when comparing a path to a namespace. For example, with the above settings, file at path `app/services/Product/Product.php` is expected to contain `Slevomat\Product\Product`, not `Slevomat\services\Product\Product`.
* `extensions`: allow different file extensions. Default is `php`.
* `ignoredNamespaces`: sniff is not performed on these namespaces.

## Files #### SlevomatCodingStandard.Files.FileLength Disallows long files. This sniff provides the following settings: * `includeComments` (default: `false`): should comments be included in the count. * `includeWhitespace` (default: `false`): should empty lines be included in the count. * `maxLinesLength` (default: `250`): specifies max allowed function lines length. #### SlevomatCodingStandard.Files.LineLength Enforces maximum length of a single line of code. Sniff provides the following settings: * `lineLengthLimit`: actual limit of the line length * `ignoreComments`: whether to ignore line length of comments * `ignoreImports`: whether to ignore line length of import (use) statements #### SlevomatCodingStandard.Files.TypeNameMatchesFileName For projects not following the [PSR-0](http://www.php-fig.org/psr/psr-0/) or [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading standards, this sniff checks whether a namespace and a name of a class/interface/trait follows agreed-on way to organize code into directories and files. Other than enforcing that the type name must match the name of the file it's contained in, this sniff is very configurable. Consider the following sample configuration: ```xml ``` Sniff provides the following settings: * `rootNamespaces` property expects configuration similar to PSR-4 - project directories mapped to certain namespaces. * `skipDirs` are not taken into consideration when comparing a path to a namespace. For example, with the above settings, file at path `app/services/Product/Product.php` is expected to contain `Slevomat\Product\Product`, not `Slevomat\services\Product\Product`. * `extensions`: allow different file extensions. Default is `php`. * `ignoredNamespaces`: sniff is not performed on these namespaces.