Methods |
public __construct(string $composerJsonPath = '') Make a FileManager. Pass a composer JSON path to use Composer dependancies. This is the path to your composer.json and composer.lock files. If you don't pass anything, InstaDoc will not search and display classes loaded via Composer |
public addGlobalNameSpaceClass(string $filename, bool $localGit = false) : void The classes in the global namespace are handled slightly differently, as this should be the exception rather than the rule.
|
public addNamespace(string $namespace, string $directory, bool $localGit = false) : PHPFUI You can add a Namespace directly. Specify the namespace (no leading backslash) and the directory containing the class files. This is realitive to the current script directory. You can also pass an option localGit flag indicating this directory is in the project git repo. This will allow you to see the git history on the file. |
public delete(string $fileName = '') : int Delete config files. This should be done when new classes have been added to the project.
|
public excludeNamespace(string $namespace) : PHPFUI Remove just one namespace from your docs. |
public excludeNamespaces(array $namespaces) : PHPFUI Sometimes you don't feel like a nut. Pass namespaces in an array to remove them from your documentation.
|
public getComposerPath() : string |
public load(string $fileName = '') : bool Load the namespace index.
|
public rescan() : PHPFUI Rescan the namespaces for the latest changes. |
public save(string $fileName = '') : bool Save the current configuration |
public setBaseFile(string $fileName) : self Set base file name for saving index file |
public setComposerPath(string $composerJsonPath) : PHPFUI |
public setConfigName(string $dirOrFilename) : PHPFUI The directory or directory/base file name to store settings. If it is a directory, the file base name will be FileManager. Several file extentions may be used |
public setExtension(string $extension = '.serial') : self Set file extension for saving index file |
Properties |
private string $composerJsonPath = '' |
private string $configFile = '..' |
private array $excludedNamespaces = []
|
private string $extension = '.serial' |
private string $fileName = '' |
private array $includedNamespaces = []
|
Methods |
private getSerializedName(string $fileName = '', string $extension = '') : string |
private loadVendorDirectories() : void Read the composer files to get all namespaces for include libraries. |