\DocumentationFolder
A specific documentation folder within a {@link DocumentationEntity}.
Maps to a folder on the file system.
Synopsis
class DocumentationFolder
extends DocumentationPage
{
- // Inherited members from DocumentationPage
- protected $title;
- protected $summary;
- protected $introduction;
- protected DocumentationEntity $entity;
- protected $path;
- protected $filename;
- protected boolean $read;
- protected $canonicalUrl;
- // methods
- public string getTitle()
- // Inherited methods from DocumentationPage
- public void __construct()
- public string getExtension()
- public string getBreadcrumbTitle()
- public DocumentationEntity getEntity()
- public string getTitle()
- public void getTitleFromFolder()
- public string getSummary()
- public string|false getMarkdown()
- public string getIntroduction()
- public string getHTML()
- public string getRelativeLink()
- public string getRelativePath()
- public string getPath()
- public string Link()
- public void populateCanonicalUrl()
- public void populateMetaDataFromText()
- public void getVersion()
- public string __toString()
- public $this setCanonicalUrl()
- public string getCanonicalUrl()
Hierarchy
Extends
Members
protected
- $canonicalUrl — string
- $entity — DocumentationEntity
- $filename
—
string
Filename - $introduction
- $path — string
- $read
- $summary
- $title — string
Methods
public
Inherited from DocumentationPage
public
- Link() — Returns the URL that will be required for the user to hit to view the given document base name.
- __toString()
- getBreadcrumbTitle()
- getCanonicalUrl() — Get the canonical URL to use for this page. Will trigger discovery via {@link DocumentationPage::populateCanonicalUrl()} if none is already set.
- getEntity()
- getExtension()
- getHTML() — Parse a file and return the parsed HTML version.
- getIntroduction()
- getMarkdown() — Return the raw markdown for a given documentation page.
- getPath()
- getRelativeLink() — This should return the link from the entity root to the page. The link value has the cleaned version of the folder names. See {@link getRelativePath()} for the actual file path.
- getRelativePath() — This should return the link from the entity root to the page. For the url polished version, see {@link getRelativeLink()}.
- getSummary()
- getTitle()
- getTitleFromFolder()
- getVersion()
- populateCanonicalUrl() — Determine and set the canonical URL for the given record, for example: dev/docs/en/Path/To/Document
- populateMetaDataFromText() — Return metadata from the first html block in the page, then remove the block on request
- setCanonicalUrl() — Set the canonical URL to use for this page