Class: PHP_UML_Input_PHP_FileScanner

Source Location: /PHP_UML-1.6.2/UML/Input/PHP/FileScanner.php

Class Overview

PHP_UML_FileScanner
   |
   --PHP_UML_Input_ImporterFileScanner
      |
      --PHP_UML_Input_PHP_FileScanner

A PHP implementation of a FileScanner.

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Inherited Variables

Class: PHP_UML_Input_ImporterFileScanner

PHP_UML_Input_ImporterFileScanner::$model

Class: PHP_UML_FileScanner

PHP_UML_FileScanner::$directories
PHP_UML_FileScanner::$files
PHP_UML_FileScanner::$ignorePatterns
PHP_UML_FileScanner::$matchPatterns

Inherited Methods

Class: PHP_UML_Input_ImporterFileScanner

PHP_UML_Input_ImporterFileScanner::__construct()
PHP_UML_Input_ImporterFileScanner::getModel(): Get the resulting, final model
PHP_UML_Input_ImporterFileScanner::import()
PHP_UML_Input_ImporterFileScanner::raiseUnknownFolderException()
PHP_UML_Input_ImporterFileScanner::setModel(): Set an initial model

Class: PHP_UML_FileScanner

PHP_UML_FileScanner::__construct(): Constructor
PHP_UML_FileScanner::raiseUnknownFolderException(): Can be overriden to treat unknown folder exception
PHP_UML_FileScanner::scan(): Starts the scan
PHP_UML_FileScanner::setDirectories()
PHP_UML_FileScanner::setFiles()
PHP_UML_FileScanner::setIgnorePatterns()
PHP_UML_FileScanner::setMatchPatterns()
PHP_UML_FileScanner::tickFile(): This function will be called every time the scanner meets a new file (while it looks into the folders), as well as for each file defined in the property $files.

Class Details

[line 28]
A PHP implementation of a FileScanner.

Author: Baptiste Autin <ohlesbeauxjours@yahoo.fr>
License: LGPL License 3

[ Top ]

Method Detail

getParserOptions [line 50]

void getParserOptions(
)

Access: public

[ Top ]

import [line 55]

void import(
)

Access: public

Overrides PHP_UML_Input_ImporterFileScanner::import() (parent method not documented)

[ Top ]

setParserOptions [line 45]

void setParserOptions(
PHP_UML_Input_PHP_ParserOptions
$options)

Access: public

Parameters:

PHP_UML_Input_PHP_ParserOptions $options —

[ Top ]

tickFile [line 74]

void tickFile(
string
$basedir, string
$filename)

Implementation of tickFile() : we parse every file met.

See: tickFile()
Access: public

Overrides PHP_UML_FileScanner::tickFile() (This function will be called every time the scanner meets a new file (while it looks into the folders), as well as for each file defined in the property $files.)

Parameters:

string	`$basedir`	—	Directory path
string	`$filename`	—	File name

[ Top ]