classes/phing/types/Excludes.php

\Excludes

Datatype which handles excluded files, classes and methods.

This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)

Extends from
\DataType
author
Benjamin Schultz
package
phing.types
since
2.4.6
version
$Id: Excludes.php 1206 2011-07-03 22:46:44Z bschultz $

Properties

Propertyprivatearray  $_classes= 'array'

Holds the excluded classes

Default valuearrayDetails
Type
array
Propertyprivate\DirectoryScanner  $_directoryScanner= 'null'

The directory scanner for getting the excluded files

Default valuenullDetails
Type
\DirectoryScanner
Propertyprivatearray  $_files= 'array'

Holds the excluded file patterns

Default valuearrayDetails
Type
array
Propertyprivatearray  $_methods= 'array'

Holds the excluded methods

Default valuearrayDetails
Type
array

Methods

methodpublic  __construct( \Project $project ) :
ctor
Parameters
Name Type Description
$project \Project
methodprivate  _addClass(  $classList ) : \ExcludesNameEntry
Adds a class to the exclusion list
Parameters
Name Type Description
$classList
Returns
Type Description
\ExcludesNameEntry
methodprivate  _addFile(  $fileList ) : \ExcludesNameEntry
Adds a file to the exclusion list
Parameters
Name Type Description
$fileList
Returns
Type Description
\ExcludesNameEntry
methodprivate  _addMethod(  $methodList ) : \ExcludesNameEntry
Adds a method to the exclusion list
Parameters
Name Type Description
$methodList
Returns
Type Description
\ExcludesNameEntry
methodpublic  createClass( ) : \ExcludesNameEntry
Add a name entry on the exclude class list
Returns
Type Description
\ExcludesNameEntry
methodpublic  createFile( ) : \ExcludesNameEntry
Add a name entry on the exclude file list
Returns
Type Description
\ExcludesNameEntry
methodpublic  createMethod( ) : \ExcludesNameEntry
Add a name entry on the exclude method list
Returns
Type Description
\ExcludesNameEntry
methodpublic  getExcludedClasses( ) : array
Returns the excluded class names
Returns
Type Description
array
methodpublic  getExcludedFiles( ) : array
Returns the excluded files
Returns
Type Description
array
methodpublic  getExcludedMethods( ) : array
Returns the excluded method names
Returns
Type Description
array
Documentation was generated by DocBlox 0.13.1.