heyday/silverstripe-hashpath

Hash path provides a function in SilverStripe templates which given a path to an asset returns a path including a hash of the asset

Thursday, July 13, 2017
by heyday
Repository
26 Watchers
11 Stars
39,104 Installations

PHP
0 Dependents
0 Suggesters
4 Forks
4 Open issues
17 Versions
5 % Grown

The README.md

Hash Path

Hash Path provides a function in SilverStripe templates which, given a path to an asset, returns a modified path with a file hash appended. In combination with a web server rewrite rule, browser caching can be completely mitigated as the file URL sent to the browser changes whenever the file does., _(*1)

// Template:
$HashPath(css/style.css)

// Rendered:                          ↙ File hash
/themes/my-theme/css/style.vpOQ8F6ybteKQQYND5dzZQ.css

License

Hash Path is licensed under an MIT license, _(*2)

Installation

Composer

Installing from composer is easy,, _(*3)

Create or edit a composer.json file in the root of your SilverStripe project, and make sure the following is present., _(*4)

{
  "require": {
    "heyday/silverstripe-hashpath": "^3.0.0"
  }
}

After completing this step, navigate in Terminal or similar to the SilverStripe root directory and run composer install or composer update depending on whether or not you have composer already in use., _(*5)

Web server config

As Hash Path returns paths that don't exist on disk, a rewrite rule needs to be added to your web server in order to return the file that was originally given to Hash Path. The URL format is .v[hash] inserted before the file extension, so you end up with .v[hash].[extension]., _(*6)

Apache

The following is required in your .htaccess file or virtual host config., _(*7)

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteBase /

    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.+)\.(v[A-Za-z0-9]+)\.(js|css|png|jpg|gif)$ $1.$3 [L]
</IfModule>

Nginx

# Hashpath module
location /themes {
    rewrite "^(.+)\.(?:v\w{10,32})\.(js|css|png|jpg|gif)$" $1.$2 last;
    try_files $uri =404;
}

How to use

Provided the correct theme is set, you can simply call $HashPath with the asset location relative to the current theme as the first argument., _(*8)

For example, for a file located at themes/my-theme/js/general.js and with my-theme current, using:, _(*9)

<script src="$HashPath("js/general.js")"></script>

will result in:, _(*10)

<script src="/themes/my-theme/js/general.v54473acf909c645bb14f011d86a47733.js"></script>

If you are wanting to use an asset that is not relative to the current theme, use:, _(*11)

<script src="$HashPath("/my-module/js/general.js", 0)"></script>

Unit Testing

PHP Unit now comes with SS, _(*12)

Running the unit tests

From the command line:, _(*13)

vendor/bin/phpunit silverstripe-hashpath/tests

Contributing

Code guidelines

This project follows the standards defined in:, _(*14)

PSR-1
PSR-2

The Versions

13/07 2017

dev-master

9999999-dev

Hash path provides a function in SilverStripe templates which given a path to an asset returns a path including a hash of the asset

silverstripe-module silverstripe-hashpath

Hash path provides a function in SilverStripe templates which given a path to an asset returns a path including a hash of the asset

heyday/silverstripe-hashpath

The README.md

Hash Path

License

Installation

Composer

Web server config

Apache

Nginx

How to use

Unit Testing

Running the unit tests

Contributing

Code guidelines

The Versions

dev-master

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

by Ben Dubuisson

3.0.2

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

by Ben Dubuisson

3.0.1

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

by Ben Dubuisson

3.0.0

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

by Ben Dubuisson

dev-upgrade-to-ss4

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

by Ben Dubuisson

2.1.x-dev

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

1.1.x-dev

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

1.1.2

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

2.0.1

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

2.0.0

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

1.0.4

The Requires

The Development Requires

by Cam Spiers

by Pieter Vanderwerff

1.1.1

The Requires

by Cam Spiers