| Constants |
| public PHPFUI\InstaDoc\Controller::CLASS_NAME = 'c' |
| public PHPFUI\InstaDoc\Controller::CSS_FILE = 'CSS' |
| public PHPFUI\InstaDoc\Controller::DOC_PAGE = 'd' |
| public PHPFUI\InstaDoc\Controller::FILE_PAGE = 'f' |
| public PHPFUI\InstaDoc\Controller::GIT_LIMIT = 'gl' |
| public PHPFUI\InstaDoc\Controller::GIT_ONPAGE = 'gp' |
| public PHPFUI\InstaDoc\Controller::GIT_PAGE = 'g' |
| public PHPFUI\InstaDoc\Controller::GIT_SHA1 = 'gs' |
| public PHPFUI\InstaDoc\Controller::NAMESPACE = 'n' |
| public PHPFUI\InstaDoc\Controller::PAGE = 'p' |
| public PHPFUI\InstaDoc\Controller::TAB_SIZE = 't' |
| Methods |
| public __construct(PHPFUI\InstaDoc\FileManager $fileManager) |
| public addHomePageMarkdown(string $path) : PHPFUI\InstaDoc\Controller |
| public clearMenu() : PHPFUI\InstaDoc\Controller Clears the cached menu in case you want to use two or more menu types on a page |
| public display(array $classPagesToShow = ['d', 'f', 'g']) : string Display a page according to the parameters passed on the url. |
| public generate(string $directoryPath, array $pagesToInclude = ['d'], string $extension = '.html') : array Generate static files for high volume sites. Pass the path to the directory where you want the files to be placed, it must exist.
|
| public getAccessTabs() : array |
| public getClassParts(string $namespacedClass) : array break up a namespaced class into parts |
| public getClassUrl(string $namespacedClass) : string Get the url given a class |
| public getControllerPage() : PHPFUI\InstaDoc\PageInterface Returns the current page for the controller that will be used to display the documentation. |
| public getFileManager() : PHPFUI\InstaDoc\FileManager |
| public getGitFileOffset() : string The git file offset is a relative path to the source to make it compatible with the git repo path. |
| public getGitRoot() : string The git root is the directory where the associated git repo lives |
| public getHomePageMarkdown() : array Get unique home page markdown files |
| public getLandingPageUrl(string $namespace) : string Return a landing page URL |
| public getMenu(?PHPFUI\Menu $menu = NULL) : PHPFUI\Menu Return a menu |
| public getNamespaceURL(string $namespace) : string Get the url for a namespace |
| public getPage() : PHPFUI\InstaDoc\PageInterface Gets a blank page and sets the page title. Override to change the generated page layout. |
| public getPageURL(string $page) : string Get the url for the specified page |
| public getParameter(string $parameter, ?string $default = NULL) : string Get a specific parameter |
| public getParameters() : array Get all parameters |
| public getSection(string $sectionName) : PHPFUI\InstaDoc\Section Get a section for display. Override to change layout |
| public getUrl(array $parameters) : string Get a url given parameters. Remove invalid parameters. |
| public setAccessTabs(array $tabs) : PHPFUI\InstaDoc\Controller |
| public setGitFileOffset(string $directory) : PHPFUI\InstaDoc\Controller The git file offset is a relative path to the source to make it compatible with the git repo path. |
| public setGitRoot(string $directory) : PHPFUI\InstaDoc\Controller This allows InstaDoc to open and display commits from the associated git repo |
| public setHomeUrl(string $url) : PHPFUI\InstaDoc\Controller Set the home URL for the nav bar menu |
| public setPageTitle(string $title) : PHPFUI\InstaDoc\Controller Set the title for the page |
| public setParameter(string $parameter, string $value) : PHPFUI\InstaDoc\Controller Set a parameter, must be valid |
| public setParameters(array $parameters) : PHPFUI\InstaDoc\Controller Set the valid parameters from an array |
| Constants |
| private PHPFUI\InstaDoc\Controller::SECTIONS = ['Git', 'File', 'Doc', 'Landing', 'Home', 'GitDiff'] |
| private PHPFUI\InstaDoc\Controller::VALID_CLASS_PAGES = ['d', 'f', 'g'] |
| private PHPFUI\InstaDoc\Controller::VALID_PARAMETERS = ['n' => '', 'c' => '', 't' => '', 'CSS' => '', 'p' => '', 'gl' => '', 'gp' => '', 'gs' => ''] |
| private PHPFUI\InstaDoc\Controller::VALID_STATIC_PARTS = ['n', 'c', 'p'] |
| Properties |
| private $accessTabs |
| private $fileManager |
| private $generating |
| private $gitFileOffset |
| private $gitRoot |
| private $homePageMarkdown |
| private $homeUrl |
| private $menu |
| private $page |
| private $parameters |
| private $siteTitle |