PHPFUI/InstaDoc

CloneableInstantiable

Public
Private

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 addNamespace(string $namespace, string $directory, bool $localGit = false) : PHPFUI\InstaDoc\FileManager

You can add a Namespace directly. Specify the namespace (no
leading ) 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() : int

Delete config files

return int number of files deleted

public excludeNamespace(string $namespace) : PHPFUI\InstaDoc\FileManager

Remove just one namespace from your docs.

public excludeNamespaces(array $namespaces) : PHPFUI\InstaDoc\FileManager

Sometimes you don't feel like a nut. Pass namespaces in an
array to remove them from your documentation.

public getComposerPath() : string

public load() : bool

Load the namespace index.

return true if file exists, false if generated

public rescan() : PHPFUI\InstaDoc\FileManager

Rescan the namespaces for the latest changes.

public save() : bool

Save the current configuration

public setComposerPath(string $composerJsonPath) : PHPFUI\InstaDoc\FileManager

public setConfigName(string $dirOrFilename) : PHPFUI\InstaDoc\FileManager

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

Properties

private $composerJsonPath

private $configFile

private $excludedNamespaces

private $includedNamespaces

Methods

private getSerializedName(string $type = '.serial') : string

private loadVendorDirectories() : void

Read the composer files to get all namespaces for include
libraries.