File Source for asset_tag

<?php
/**
* File containing the AssetTagHelper class and support functions
*
* (PHP 5)
*
* @package PHPonTrax
* @version $Id: asset_tag_helper.php 228 2006-07-16 15:53:11Z john $
* @copyright (c) 2005 John Peterson
*
* 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.
*/
/**
* Utility to help build HTML/XML link tags for public assets
*/
class AssetTagHelper extends Helpers {
/**
* @var string[]
*/
var $javascript_default_sources = null;
/**
* @todo Document this method
*
* @uses javascript_default_sources
*/
function __construct() {
parent::__construct();
$this->javascript_default_sources =
array_key_exists('JAVASCRIPT_DEFAULT_SOURCES',$GLOBALS)
? $GLOBALS['JAVASCRIPT_DEFAULT_SOURCES']
: array('prototype', 'effects', 'controls', 'dragdrop');
}
/**
* Compute public path to an asset
*
* Build the public path, suitable for inclusion in a URL, to an
* asset. Arguments are the filename, directory and extension of
* the asset.
* @param string Filename of asset
* @param string Default directory name, if none in $source
* @param string Default file extension, if none in $source
* @return string Public path to the asset
* @uses controller_object
* @uses ActionController::asset_host
*/
private function compute_public_path($source, $dir, $ext) {
// Test whether source is a URL, ie. starts something://
if(!preg_match('/^[-a-z]+:\/\//', $source)) {
// Source is not a URL.
// If path doesn't start with '/', prefix /$dir/
if($source{0} != '/') {
$source = "/{$dir}/{$source}";
}
// If no '.' in source file name, add '.ext'
if(!strstr($source, '.')) {
$source = "{$source}.{$ext}";
}
// If Trax::$url_prefix non-null, prefix it to path
if(!is_null(Trax::$url_prefix)) {
$prefix = Trax::$url_prefix;
if($prefix{0} != "/") {
$prefix = "/$prefix";
}
$source = $prefix . ((substr($prefix, -1) == "/")
? substr($source, 1) : $source);
}
}
// If controller defined and has asset_host value
// prefix that to path
// FIXME: won't this cause a problem if $source was http://...?
if ( isset($this->controller_object)
&& isset($this->controller_object->asset_host) ) {
$source = $this->controller_object->asset_host . $source;
}
return $source;
}
/**
* Compute public path to a javascript asset
*
* Build the public path, suitable for inclusion in a URL, to a
* javascript asset. Argument is the filename of the asset.
* Default directory to 'javascripts', extension to '.js'
* @param string Filename of asset, in one of the formats
* accepted as the $filename argument of
* {@link compute_public_path()}
* @return string Public path to the javascript asset
* @uses compute_public_path()
*/
function javascript_path($source) {
return $this->compute_public_path($source, 'javascripts', 'js');
}
/**
* Return script include tag for one or more javascript assets
*
* javascript_include_tag("xmlhr"); =>
* <script type="text/javascript" src="/javascripts/xmlhr.js"></script>
*
* javascript_include_tag("common.javascript", "/elsewhere/cools"); =>
* <script type="text/javascript" src="/javascripts/common.javascript"></script>
* <script type="text/javascript" src="/elsewhere/cools.js"></script>
*
* javascript_include_tag("defaults"); =>
* <script type="text/javascript" src="/javascripts/prototype.js"></script>
* <script type="text/javascript" src="/javascripts/effects.js"></script>
* <script type="text/javascript" src="/javascripts/controls.js"></script>
* <script type="text/javascript" src="/javascripts/dragdrop.js"></script>
* @param mixed The arguments are zero or more strings, followed
* by an optional array containing options
* @return string
* @uses content_tag()
* @uses javascript_default_sources
* @uses javascript_path()
*/
function javascript_include_tag() {
if(func_num_args() > 0) {
$sources = func_get_args();
$options = (is_array(end($sources))
? array_pop($sources) : array());
if(in_array('defaults', $sources)) {
if(is_array($this->javascript_default_sources)) {
$sources = array_merge($this->javascript_default_sources,
$sources);
}
if(file_exists(Trax::$public_path. "/javascripts/application.js")) {
$sources[] = 'application';
}
# remove defaults from array
unset($sources[array_search('defaults', $sources)]);
}
$contents = array();
foreach($sources as $source) {
$source = $this->javascript_path($source);
$contents[] = $this->content_tag("script", "",
array_merge(array("type" => "text/javascript",
"src" => $source), $options));
}
return implode("", $contents);
}
}
/**
* Compute public path to a stylesheet asset
*
* Build the public path, suitable for inclusion in a URL, to a
* stylesheet asset. Argument is the filename of the asset.
* Default directory to 'stylesheets', extension to '.css'
* @param string Filename of asset, in one of the formats
* accepted as the $filename argument of
* {@link compute_public_path()}
* @return string Public path to the stylesheet asset
* @uses compute_public_path()
*/
function stylesheet_path($source) {
return $this->compute_public_path($source, 'stylesheets', 'css');
}
/**
* Build link tags to one or more stylesheet assets
*
* @param mixed One or more assets, optionally followed by an
* array describing options to apply to the tags
* generated for these assets.<br> Each asset is a
* string in one of the formats accepted as value
* of the $source argument of
* {@link stylesheet_path()}.<br> The optional last
* argument is an array whose keys are names of
* attributes of the link tag and whose corresponding
* values are the values assigned to each
* attribute. If omitted, options default to:
* <ul>
* <li>"rel" => "Stylesheet"</li>
* <li>"type" => "text/css"</li>
* <li>"media" => "screen"</li>
* <li>"href" => <i>path-to-source</i></li>
* </ul>
* @return string A link tag for each asset in the argument list
* @uses stylesheet_path()
* @uses tag()
*/
function stylesheet_link_tag() {
if(func_num_args() > 0) {
$sources = func_get_args();
$options = (is_array(end($sources))
? array_pop($sources) : array());
$contents = array();
foreach($sources as $source) {
$source = $this->stylesheet_path($source);
$contents[] = $this->tag("link",
array_merge(array("rel" => "Stylesheet",
"type" => "text/css",
"media" => "screen",
"href" => $source), $options));
}
return implode("", $contents);
}
}
/**
* Compute public path to a image asset
*
* Build the public path, suitable for inclusion in a URL, to a
* image asset. Argument is the filename of the asset.
* Default directory to 'images', extension to '.png'
* @param string Filename of asset, in one of the formats
* accepted as the $filename argument of
* {@link compute_public_path()}
* @return string Public path to the image asset
* @uses compute_public_path()
*/
function image_path($source) {
return $this->compute_public_path($source, 'images', 'png');
}
/**
* Build image tags to an image asset
*
* @param mixed An image asset optionally followed by an
* array describing options to apply to the tag
* generated for this asset.<br>The asset is a
* string in one of the formats accepted as value
* of the $source argument of
* {@link image_path()}.<br> The optional second
* argument is an array whose keys are names of
* attributes of the image tag and whose corresponding
* values are the values assigned to each
* attribute. The image size can be specified in
* two ways: by specifying option values "width" =>
* <i>width</i> and "height" => <i>height</i>, or
* by specifying option "size" => "<i>width</i>
* x <i>height</i>". If omitted, options default to:
* <ul>
* <li>"alt" => <i>humanized filename</i></li>
* <li>"width" and "height" value computed from
* value of "size"</li>
* </ul>
* @return string A image tag for each asset in the argument list
* @uses image_path()
* @uses tag()
*/
function image_tag($source, $options = array()) {
$options['src'] = $this->image_path($source);
$options['alt'] = array_key_exists('alt',$options)
? $options['alt']
: Inflector::capitalize(reset($file_array =
explode('.', basename($options['src']))));
if(isset($options['size'])) {
$size = explode('x', $options["size"]);
$options['width'] = reset($size);
$options['height'] = end($size);
unset($options['size']);
}
return $this->tag("img", $options);
}
/**
* Returns a link tag that browsers and news readers can use to
* auto-detect a RSS or ATOM feed for this page. The $type can
* either be <tt>:rss</tt> (default) or <tt>:atom</tt> and the
* $options follow the url_for() style of declaring a link
* target.
*
* Examples:
* auto_discovery_link_tag =>
* <link rel="alternate" type="application/rss+xml" title="RSS"
* href="http://www.curenthost.com/controller/action" />
* auto_discovery_link_tag(:atom) =>
* <link rel="alternate" type="application/atom+xml"
* title="ATOM"
* href="http://www.curenthost.com/controller/action" />
* auto_discovery_link_tag(:rss, {:action => "feed"}) =>
* <link rel="alternate" type="application/rss+xml" title="RSS"
* href="http://www.curenthost.com/controller/feed" />
* auto_discovery_link_tag(:rss, {:action => "feed"}, {:title =>
* "My RSS"}) =>
* <link rel="alternate" type="application/rss+xml" title="My
* RSS" href="http://www.curenthost.com/controller/feed" />
* @uses tag()
* @uses url_for()
*/
function auto_discovery_link_tag($type = 'rss', $options = array(),
$tag_options = array()) {
return $this->tag(
"link", array(
"rel" => (array_key_exists('rel',$tag_options)
? $tag_options['rel'] : "alternate"),
"type" => (array_key_exists('type',$tag_options)
? $tag_options['type']
: "application/{$type}+xml"),
"title" => (array_key_exists('title',$tag_options)
? $tag_options['title']
: strtoupper($type)),
"href" => url_for(array_merge($options,
array('only_path' => false))))
);
}
}
/**
* Make a new AssetTagHelper object and call its auto_discovery_link_tag() method
* @uses AssetTagHelper::auto_discovery_link_tag()
*/
function auto_discovery_link_tag() {
$asset_helper = new AssetTagHelper();
$args = func_get_args();
return call_user_func_array(array($asset_helper, 'auto_discovery_link_tag'), $args);
}
/**
* Make a new AssetTagHelper object and call its image_tag() method
* @uses AssetTagHelper::image_tag()
*/
function image_tag() {
$asset_helper = new AssetTagHelper();
$args = func_get_args();
return call_user_func_array(array($asset_helper, 'image_tag'), $args);
}
/**
* Make a new AssetTagHelper object and call its stylesheet_link_tag() method
* @uses AssetTagHelper::stylesheet_link_tag()
*/
function stylesheet_link_tag() {
$asset_helper = new AssetTagHelper();
$args = func_get_args();
return call_user_func_array(array($asset_helper, 'stylesheet_link_tag'), $args);
}
/**
* Make a new AssetTagHelper object and call its javascript_include_tag() method
* @uses AssetTagHelper::javascript_include_tag()
*/
function javascript_include_tag() {
$asset_helper = new AssetTagHelper();
$args = func_get_args();
return call_user_func_array(array($asset_helper, 'javascript_include_tag'), $args);
}
// -- set Emacs parameters --
// Local variables:
// tab-width: 4
// c-basic-offset: 4
// c-hanging-comment-ender-p: nil
// indent-tabs-mode: nil
// End:
?>

Source for file asset_tag_helper.php