new placeholders {{checksum}} {{timestamp}} & add timestamp to placeholder {{sprite}}

Author: ernscht

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## v1.2.2 - 2015-03
 
 * [feature] configuration: add possibility to configure tile margins
+* [feature] new placeholders {{checksum}} {{timestamp}} & add timestamp to placeholder {{sprite}}
 * [maintenance] new placeholder {{sprite}} in ratio template
 
 ## v1.2.1 - 2015-01-29

README.md

@@ -105,12 +105,14 @@ Spriter comes with the following default template:
 
 The following placeholders can be used inside the global template:
 
-* {{namespace}} = configured namespace
-* {{width}} = generated sprite width
-* {{height}} = generated sprite height
 * {{spriteFilepath}} = configured sprite directory
 * {{spriteFilename}} = configured sprite filename
-* {{sprite}} = {{spriteFilepath}}/{{spriteFilename}}.png
+* {{sprite}} = {{spriteFilepath}}/{{spriteFilename}}.png?{{timestamp}}
+* {{width}} = generated sprite width
+* {{height}} = generated sprite height
+* {{namespace}} = configured namespace
+* {{checksum}} = sprite checksum
+* {{timestamp}} = generation time
 
 ### Each Template
 
@@ -160,15 +162,17 @@ This is the default template:
 
 You can use the following placeholders:
 
+* {{spriteFilepath}} = configured sprite directory
+* {{spriteFilename}} = configured sprite filename
+* {{sprite}} = {{spriteFilepath}}/{{spriteFilename}}{{delimiter}}{{ratio}}x.png?{{timestamp}}
 * {{ratio}} = the retina ratio value
 * {{ratioFrag}} = the retina ratio value as a fragment (for opera)
-* {{delimiter}} = the configured delimiter
-* {{namespace}} = configured namespace
 * {{width}} = generated sprite width
 * {{height}} = generated sprite height
-* {{spriteFilepath}} = configured sprite directory
-* {{spriteFilename}} = configured sprite filename
-* {{sprite}} = {{spriteFilepath}}/{{spriteFilename}}{{delimiter}}{{ratio}}x.png
+* {{delimiter}} = the configured delimiter
+* {{namespace}} = configured namespace
+* {{checksum}} = sprite checksum
+* {{timestamp}} = generation time
 
 ## Contributing
 

spriter/spriter.class.php

@@ -24,6 +24,7 @@ class Spriter {
 	protected $eachTemplate;
 	protected $eachHoverTemplate;
 	protected $ratioTemplate;
+	protected $timestamp;
 	protected $forceGenerate = false;
 	protected $ignoreHover = false;
 	protected $hoverSuffix = "-hover";
@@ -49,6 +50,7 @@ public function __construct( $config = array() ) {
 			// setup & generation
 			$this->setupIcons();
 			if ( $this->hasChanged() || $this->forceGenerate ) {
+				$this->timestamp = date( 'YmdHis', time() );
 				$this->generateChecksum();
 				$this->generateSprite();
 				$this->generateCSS();
@@ -105,6 +107,15 @@ private function hasChanged() {
 				return true;
 			}
 		}
+
+		// Check if the generated css file exists
+		foreach ( $this->targets as $target ) {
+			if ( !file_exists( $target['cssDirectory'] . "/" . $target['cssFilename'] ) ) {
+				return true;
+			}
+		}
+
+		// Checksum comparison
 		if ( file_exists( __DIR__ . "/" . $this->getChecksumName() ) ) {
 			$lastChecksum = file_get_contents( __DIR__ . "/" . $this->getChecksumName() );
 
@@ -115,12 +126,6 @@ private function hasChanged() {
 		else {
 			return true;
 		}
-		// Check if the generated css file exists
-		foreach ( $this->targets as $target ) {
-			if ( !file_exists( $target['cssDirectory'] . "/" . $target['cssFilename'] ) ) {
-				return true;
-			}
-		}
 
 		return false;
 	}
@@ -317,13 +322,16 @@ private function generateCSS() {
 			$result = "";
 
 			$replacements = array(
-				"{{spriteDirectory}}" => $this->spriteFilepath, // deprecated
 				"{{spriteFilepath}}"  => $this->spriteFilepath,
 				"{{spriteFilename}}"  => $this->spriteFilename,
-				"{{sprite}}"          => $this->spriteFilepath . "/" . $this->spriteFilename . ".png",
-				"{{namespace}}"       => $this->namespace,
+				"{{sprite}}"          => $this->spriteFilepath . "/" . $this->spriteFilename . ".png?" . $this->timestamp,
 				"{{width}}"           => $this->width . "px",
-				"{{height}}"          => $this->height . "px"
+				"{{height}}"          => $this->height . "px",
+				"{{namespace}}"       => $this->namespace,
+				"{{checksum}}"        => $this->spriteChecksum,
+				"{{timestamp}}"       => $this->timestamp,
+
+				"{{spriteDirectory}}" => $this->spriteFilepath // deprecated
 			);
 
 			$result .= str_replace(
@@ -344,16 +352,19 @@ private function generateCSS() {
 				foreach ( $this->retina as $ratio ) {
 					if ( $ratio > 1 ) {
 						$replacements = array(
-							"{{spriteDirectory}}" => $this->spriteFilepath, // deprecated
 							"{{spriteFilepath}}"  => $this->spriteFilepath,
 							"{{spriteFilename}}"  => $this->spriteFilename,
-							"{{sprite}}"          => $this->spriteFilepath . "/" . $this->spriteFilename . $this->retinaDelimiter . $ratio . "x.png",
-							"{{namespace}}"       => $this->namespace,
+							"{{sprite}}"          => $this->spriteFilepath . "/" . $this->spriteFilename . $this->retinaDelimiter . $ratio . "x.png?" . $this->timestamp,
 							"{{ratio}}"           => $ratio,
 							"{{ratioFrag}}"       => $ratio . "/1",
 							"{{width}}"           => $this->width . "px",
 							"{{height}}"          => $this->height . "px",
-							"{{delimiter}}"       => $this->retinaDelimiter
+							"{{delimiter}}"       => $this->retinaDelimiter,
+							"{{namespace}}"       => $this->namespace,
+							"{{checksum}}"        => $this->spriteChecksum,
+							"{{timestamp}}"       => $this->timestamp,
+
+							"{{spriteDirectory}}" => $this->spriteFilepath, // deprecated
 						);
 						$ratios       = str_replace(
 							                array_keys( $replacements ),