MarkdownPageCollection
in package
Creates a Collection of MarkdownPage objects
The Collection is used to create the sidebar and the Collection of files for the StaticPageBuilder to generate.
Tags
Table of Contents
- $pages : Collection
- The Collection object.
- __construct() : mixed
- Construct the object by generating the Collection.
- get() : Collection
- Get the created Collection instance.
- order() : self
- Sort the Collection.
- withoutRoutes() : self
- Remove the specified routes from the collection.
- generate() : Collection
- Create a new Collection.
Properties
$pages
The Collection object.
protected
Collection
$pages
Methods
__construct()
Construct the object by generating the Collection.
public
__construct() : mixed
Return values
mixed —get()
Get the created Collection instance.
public
get() : Collection
Return values
Collection —order()
Sort the Collection.
public
order() : self
Uses the order priority set in the MarkdownPage object
Return values
self —withoutRoutes()
Remove the specified routes from the collection.
public
withoutRoutes([array<string|int, mixed> $routes = ['index', '404'] ]) : self
If the route parameter is not set it defaults to removing the 'index' and '404' routes.
Parameters
- $routes : array<string|int, mixed> = ['index', '404']
-
to remove
Return values
self —generate()
Create a new Collection.
private
generate() : Collection
Tags
Return values
Collection —$pages