\StaticPublisher
Synopsis
class StaticPublisher
extends DataExtension
{
- // members
- private static boolean $echo_progress = false;
- private static boolean $disable_realtime = false;
- private static boolean $static_publisher_theme = false;
- private static boolean $include_caching_metadata = false;
- // methods
- public abstract void publishPages()
- public abstract void unpublishPages()
- public static void set_static_publisher_theme()
- public static string static_publisher_theme()
- public static boolean echo_progress()
- public static void set_echo_progress()
- public void onAfterPublish()
- public void onRenameLinkedAsset()
- public void republish()
- public void onAfterUnpublish()
- public array getMetadata()
Hierarchy
Extends
- DataExtension
Members
private
- $disable_realtime
—
boolean
Realtime static publishing... the second a page is saved, it is written to the cache. - $echo_progress
—
boolean
Defines whether to output information about publishing or not. By default, this is off, and should be turned on when you want debugging (for example, in a cron task). - $include_caching_metadata — boolean
- $static_publisher_theme
—
string
This is the current static publishing theme, which can be set at any point. If it's not set, then the last non-null theme, set via SSViewer::set_theme() is used. The obvious place to set this is in _config.php
Methods
public
- echo_progress()
- getMetadata()
- onAfterPublish() — Called after a page is published.
- onAfterUnpublish() — Get changes and hook into underlying functionality.
- onRenameLinkedAsset() — Called after link assets have been renamed, and the live site has been updated, without an actual publish event.
- publishPages()
- republish()
- set_echo_progress()
- set_static_publisher_theme()
- static_publisher_theme()
- unpublishPages()