[ Index ]

PHP Cross Reference of Automap

title

Body

[close]

/Automap/Build/ -> Creator.php (summary)

(no description)

Copyright: Francois Laupretre <automap@tekwire.net>
License: http://www.apache.org/licenses/LICENSE-2.0 Apache License, V 2.0
File Size: 503 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Creator:: (24 methods):
  __construct()
  setParser()
  option()
  setOption()
  unsetOption()
  setPhpFileExt()
  addEntry()
  addTSEntry()
  symbolCount()
  mkVarray()
  addSymbol()
  unregisterTarget()
  serialize()
  save()
  registerExtensionFile()
  registerExtensionDir()
  normalizePath()
  registerScriptFile()
  registerPath()
  readMapFile()
  mergeMapFile()
  mergeMapSymbols()
  registerPhkPkg()
  import()


Class: Creator  - X-Ref

__construct($parser=null)   X-Ref
No description

setParser($parser=null)   X-Ref
No description

option($opt)   X-Ref
No description

setOption($option,$value)   X-Ref
No description

unsetOption($option)   X-Ref
No description

setPhpFileExt($a)   X-Ref
Set the list of file suffixes recognized as PHP source scripts

Default list is 'php, 'inc, 'hh'.

param: array|string If array, replace the list, otherwise add a suffix to the list
return: null

addEntry($va)   X-Ref
No description

addTSEntry($stype,$sname,$va)   X-Ref
No description

symbolCount()   X-Ref
No description

mkVarray($ftype,$fpath,$ns_filter=null)   X-Ref
No description

addSymbol($stype,$sname,$ftype,$fpath)   X-Ref
No description

unregisterTarget($va)   X-Ref
No description

serialize()   X-Ref
No description

save($path)   X-Ref
No description

registerExtensionFile($file)   X-Ref
No description

registerExtensionDir()   X-Ref
No description

normalizePath($path)   X-Ref
Normalize a destination path

1. Replace backslashes with forward slashes.
2. Remove trailing slashes

param: string $rpath the path to normalize
return: string the normalized path

registerScriptFile($fpath,$rpath,$ns_filter=null)   X-Ref
No description

registerPath($fpath,$rpath,$ns_filter=null,$file_pattern=null)   X-Ref
Recursively scan a path and records symbols

Scan retains PHP source files and phk packages only (based on file suffix)

Only dirs and regular files are considered. Other types are ignored.

param: string $fpath Path to register
param: string $rpath Path to register to in map for $fpath
param: string|array|null $ns_filter
param: string|null $file_pattern

readMapFile($fpath)   X-Ref
No description

mergeMapFile($fpath,$rpath)   X-Ref
Merge an existing map file into the current map

Import symbols only. Options are ignored (including base path).

param: string $fpath Path of the map to merge (input)
param: Relative path to prepend to map target paths
return: null

mergeMapSymbols($map,$rpath='.')   X-Ref
No description

registerPhkPkg($fpath,$rpath)   X-Ref
No description

import($path=null)   X-Ref
No description



Generated: Thu Jun 4 18:32:29 2015 Cross-referenced by PHPXref 0.7.1