tonyair/silverstripe-staticpublisher
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-staticpublisher synced 2024-10-22 14:05:54 +02:00
Code Issues Projects Releases Wiki Activity

Update docs for 3.1

Browse Source
This commit is contained in:
Will Rossiter 2013-04-05 21:33:12 +13:00
parent 9cbc0f22f1
commit 84d70b183e
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/en/StaticPublisher.md
View File

@ -28,20 +28,31 @@ which time they are considered outdated. By adding a custom method
caching, and hook in custom logic. This array of URLs is used by the publisher caching, and hook in custom logic. This array of URLs is used by the publisher
to generate folders and HTML-files. to generate folders and HTML-files.
First add the FilesystemPublisher extension to your object. See the
[DataExtension](http://doc.silverstripe.org/framework/en/reference/dataextension)
documentation for more ways to add the extension to your SiteTree.
:::php
SiteTree::add_extension("FilesystemPublisher('cache/')");
Once you've added the extension, define the pages you would like to cache from
your Page class:
:::php :::php
class Page extends SiteTree { class Page extends SiteTree {
// ... // ...
/** /**
* Return a list of all the pages to cache * Return a list of all the pages to cache
*
* @return array
*/ */
public function allPagesToCache() { public function allPagesToCache() {
// Get each page type to define its sub-urls // Get each page type to define its sub-urls
$urls = array(); $urls = array();
// memory intensive depending on number of pages // memory intensive depending on number of pages
$pages = SiteTree::get(); $pages = Page::get();
foreach($pages as $page) { foreach($pages as $page) {
$urls = array_merge($urls, (array)$page->subPagesToCache()); $urls = array_merge($urls, (array)$page->subPagesToCache());
@ -54,7 +65,9 @@ to generate folders and HTML-files.
} }
/** /**
* Get a list of URLs to cache related to this page * Get a list of URLs to cache related to this page.
*
* @return array
*/ */
public function subPagesToCache() { public function subPagesToCache() {
$urls = array(); $urls = array();
@ -64,17 +77,22 @@ to generate folders and HTML-files.
// cache the RSS feed if comments are enabled // cache the RSS feed if comments are enabled
if ($this->ProvideComments) { if ($this->ProvideComments) {
$urls[] = Director::absoluteBaseURL() . "pagecomment/rss/" . $this->ID; $urls[] = Director::absoluteBaseURL() . "CommentingController/rss/SiteTree/" . $this->ID;
} }
return $urls; return $urls;
} }
/**
* Get a list of URL's to publish when this page changes
*/
public function pagesAffectedByChanges() { public function pagesAffectedByChanges() {
$urls = $this->subPagesToCache(); $urls = $this->subPagesToCache();
if($p = $this->Parent) $urls = array_merge((array)$urls, (array)$p->subPagesToCache()); if($p = $this->Parent) $urls = array_merge((array)$urls, (array)$p->subPagesToCache());
return $urls; return $urls;
} }
} }
## Excluding Pages ## Excluding Pages