silverstripe/staticpublishqueue

Static publishing queue to create static versions of pages for enhanced performance and security

7.0.0-alpha1 2024-10-30 21:53 UTC

Requires

• php: ^8.3
• silverstripe/cms: ^6
• silverstripe/config: ^3
• silverstripe/framework: ^6
• silverstripe/versioned: ^3
• symbiote/silverstripe-queuedjobs: ^6

Requires (Dev)

• phpstan/extension-installer: ^1.3
• silverstripe/recipe-testing: ^4
• silverstripe/standards: ^1

BSD-3-Clause

• queue
• performance
• security
• cache
• html
• static
• caching
• silverstripe
• static-publishing
• static-caching
• static-cache
• publishing

README

Installation

composer require silverstripe/staticpublishqueue

Brief

This module provides an API for your project to be able to generate a static cache of your pages to enhance performance by not booting Silverstripe in order to serve requests.

It generates the cache files using the QueuedJobs module.

Docs

Unit-testing with StaticPublisherState to disable queuedjobs for unit-tests

You can use StaticPublisherState to disable queuejobs job queueing and logging in unit-testing to improve performance.

Add the following yml to your project:

----
Name: staticpublishqueue-tests
Only:
  classexists:
    - 'Symbiote\QueuedJobs\Tests\QueuedJobsTest\QueuedJobsTest_Handler'
    - 'SilverStripe\StaticPublishQueue\Test\QueuedJobsTestService'
----
SilverStripe\Core\Injector\Injector:
  SilverStripe\Dev\State\SapphireTestState:
    properties:
      States:
        staticPublisherState: '%$SilverStripe\StaticPublishQueue\Dev\StaticPublisherState'