Class: PHP_UML_Input_ImporterFileScanner

Source Location: /PHP_UML-1.6.2/UML/Input/ImporterFileScanner.php

Class Overview

PHP_UML_FileScanner
   |
   --PHP_UML_Input_ImporterFileScanner

Defines a way to import data by relying on a scan of a set of files/folders, and then get the result as a UML model (as a superstructure).

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Variables

$model

Methods

Child classes:

PHP_UML_Input_PHP_FileScanner: A PHP implementation of a FileScanner.

PHP_UML_Input_XMI_FileScanner: An XMI implementation of an ImporterFileScanner.

Inherited Variables

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_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]
Defines a way to import data by relying on a scan of a set of files/folders, and then get the result as a UML model (as a superstructure).

Implements PHP_UML_Input_Importer.

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

[ Top ]

Class Variables

$model =

[line 35]

Superstructure (model) to fill

Access: protected

Type:

PHP_UML_Metamodel_Superstructure

[ Top ]

Method Detail

__construct (Constructor) [line 37]

PHP_UML_Input_ImporterFileScanner __construct(
[PHP_UML_Metamodel_Superstructure
$model = null])

Access: public

Overrides PHP_UML_FileScanner::__construct() (Constructor)

Parameters:

PHP_UML_Metamodel_Superstructure $model —

[ Top ]

getModel [line 52]

PHP_UML_Metamodel_Superstructure getModel(
)

Get the resulting, final model

Access: public

[ Top ]

import [line 57]

void import(
)

Abstract:
Access: public

Overridden in child classes as:

PHP_UML_Input_PHP_FileScanner::import()

PHP_UML_Input_XMI_FileScanner::import()

[ Top ]

raiseUnknownFolderException [line 69]

void raiseUnknownFolderException(

$basedir)

Access: public

Overrides PHP_UML_FileScanner::raiseUnknownFolderException() (Can be overriden to treat unknown folder exception)

Parameters:

$basedir —

[ Top ]

setModel [line 64]

void setModel(
PHP_UML_Metamodel_Superstructure
$model)

Set an initial model

Access: public

Parameters:

PHP_UML_Metamodel_Superstructure $model — New model

[ Top ]