Download the PHP package buzzingpixel/craft-static without Composer

On this page you can find all versions of the php package buzzingpixel/craft-static. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package craft-static

Craft Static

Static file caching for Craft 3

Installing

(Please see section below for instructions on setting up the cron job to clear cache for future or expiring entries)

Composer

From the command line run:

composer require buzzingpixel/craft-static

After installing via composer, go to your Craft CP > Settings > Plugins and install Craft Static.

Craft Plugin Store

The other way is through the plugin store in the Craft CP.

Configuration

There are two globally configurable options:

Usage

Usage in Twig

The entire contents of your HTML output should be wrapped in the {% static %} tag so it's best to put this in the outermost layout file. You can also specify whether the tag should actually cache or not so you can disable caching in some scenarios and still wrap your entire contents in the tag.

Example:

Alternative usage in a controller

If you would like to use a controller to render your output, or otherwise statically cache from PHP, you can use:

A full(er) example:

Cache clearing

The cache will be purged any time an element is saved. It can also be cleared manually from the CP's Utilites > Clear Caches section.

Cache Clearing via command line

The cache can be cleared from the command line, but note that you must define the cachePath via custom config because $_SERVER['DOCUMENT_ROOT'] is not defined when running on the console and you might end up deleting things on the server you didn't mean to. You can use a config setting something like this:

To purge static cache from the command line, run: ./craft craft-static/cache/purge

Cron job

Craft Static keeps track of future and expiring entries but in order for Craft Static to clear the static cache when an entry expires or it's previously future post date because past, you need to be running a cron job every minute. That command is:

Here's an example of what that cron job might look like:

License

Copyright 2019 BuzzingPixel, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


All versions of craft-static with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
craftcms/cms Version ^3.1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package buzzingpixel/craft-static contains the following files

Loading the files please wait ....