pickles/docs/PICKLES/Dynamic.html

197 lines
No EOL
8 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Dynamic</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Dynamic</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dynamic Class</p>
<p class="description"><p>Handles generating links to static content that are a timestamp injected as to avoid hard caching. Also minifies content where applicable.</p><p>Note: you will want to add a mod_rewrite line to your .htaccess to support the routing to the filenames with the timestamp injected:</p><p>RewriteRule ^(.+)\.([\d]+)\.(css|js|gif|png|jpg|jpeg)$ /$1.$3 [NC,QSA]</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Dynamic.php.html">/classes/Dynamic.php</a> (line <span class="field">29</span>)
</p>
<pre>Object
|
--Dynamic</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">string</span>
<a href="#css" title="details" class="method-name">css</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$original_reference</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#js" title="details" class="method-name">js</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$original_reference</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">'simple'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#reference" title="details" class="method-name">reference</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$failover</span> = <span class="var-default">false</span>])
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodcss" id="css"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">css</span> (line <span class="line-number">108</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate Stylesheet Reference</p>
<p class="description"><p>Attempts to minify the stylesheet and then returns the reference URI for the file, minified or not.</p></p>
<ul class="tags">
<li><span class="field">return:</span> URI reference reference with dynamic content</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
css
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$original_reference</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$reference</span><span class="var-description">: URI reference of the Stylesheet</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$original_reference</span> </li>
</ul>
</div>
<a name="methodjs" id="js"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">js</span> (line <span class="line-number">175</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate Javascript Reference</p>
<p class="description"><p>Attempts to minify the source with Google's Closure compiler, and then returns the reference URI for the file, minified or not.</p></p>
<ul class="tags">
<li><span class="field">return:</span> URI reference reference with dynamic content</li>
<li><span class="field">link:</span> <a href="http://code.google.com/closure/compiler/">http://code.google.com/closure/compiler/</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
js
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$original_reference</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">'simple'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$reference</span><span class="var-description">: URI reference of the Javascript file</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$original_reference</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$level</span> </li>
</ul>
</div>
<a name="methodreference" id="reference"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">reference</span> (line <span class="line-number">41</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate Reference</p>
<p class="description"><p>Appends a dynamic piece of information to the passed reference in the form of a UNIX timestamp added to the query string.</p></p>
<ul class="tags">
<li><span class="field">return:</span> URI reference reference with dynamic content</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
reference
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$reference</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$failover</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$reference</span><span class="var-description">: URI reference of the file</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$failover</span><span class="var-description">: URI reference to use if the reference can't be found</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
</p>
</div></body>
</html>