Changeset 8483

Timestamp:

04/16/08 18:43:54 (4 months ago)

Author:

fabien

Message:

added some helpers to ease the use of dynamic javascripts and stylesheets (actions with a sf_format of sf or css)

Files:

• branches/1.1/lib/helper/AssetHelper.php (modified) (1 diff)
• branches/1.1/test/unit/helper/AssetHelperTest.php (modified) (3 diffs)

branches/1.1/lib/helper/AssetHelper.php

@@ -536 +536 @@
-  echo get_stylesheets();
-}
+
+/**
+ * Returns a <script> include tag for the given internal URI.
+ *
+ * The helper automatically adds the sf_format to the internal URI, so you don't have to.
+ *
+ * @param  string  The internal URI for the dynamic javascript
+ * @param  Boolean Whether to generate an absolute URL
+ * @param  array   An array of options (absolute)
+ *
+ * @return string  XHTML compliant <script> tag(s)
+ * @see    javascript_include_tag 
+ */
+function dynamic_javascript_include_tag($uri, $absolute = false, $options = array())
+{
+  $options['raw_name'] = true;
+
+  return javascript_include_tag(_dynamic_path($uri, 'js', $absolute), $options);
+}
+
+/**
+ * Adds a dynamic javascript to the response object.
+ *
+ * The first argument is an internal URI.
+ * The helper automatically adds the sf_format to the internal URI, so you don't have to.
+ *
+ * @see sfResponse->addJavascript()
+ */
+function use_dynamic_javascript($js, $position = '', $options = array())
+{
+  $options['raw_name'] = true;
+
+  return use_javascript(_dynamic_path($js, 'js'), $position, $options);
+}
+
+/**
+ * Adds a dynamic stylesheet to the response object.
+ *
+ * The first argument is an internal URI.
+ * The helper automatically adds the sf_format to the internal URI, so you don't have to.
+ *
+ * @see sfResponse->addStylesheet()
+ */
+function use_dynamic_stylesheet($css, $position = '', $options = array())
+{
+  $options['raw_name'] = true;
+
+  return use_stylesheet(_dynamic_path($css, 'css'), $position, $options);
+}
+
+function _dynamic_path($uri, $format, $absolute = false)
+{
+  return url_for($uri.(false === strpos($uri, '?') ? '?' : '&').'sf_format='.$format, $absolute);
+}

branches/1.1/test/unit/helper/AssetHelperTest.php

@@ -16 +16 @@
-require_once(dirname(__FILE__).'/../../../lib/helper/AssetHelper.php');
-
-45
+53
-
-class myRequest
@@ -38 +38 @@
-}
-
-
+
+
+
+
+
+
+
+
+
-
-// _compute_public_path()
@@ -159 +167 @@
-  '<link rel="stylesheet" type="text/css" media="screen" href="/css/style.css" />'."\n".'<link rel="stylesheet" type="text/css" media="screen" href="/css/style2.css" />'."\n",
-  'get_stylesheets() returns all the stylesheets previously added by use_stylesheet()');
+
+// _dynamic_path()
+$t->diag('_dynamic_path()');
+$t->is(_dynamic_path('module/action', 'js'), 'module/action?sf_format=js', '_dynamic_path() converts an internal URI to a URL');
+$t->is(_dynamic_path('module/action?key=value', 'js'), 'module/action?key=value&sf_format=js', '_dynamic_path() converts an internal URI to a URL');
+$t->is(_dynamic_path('module/action', 'js', true), '/module/action?sf_format=js', '_dynamic_path() converts an internal URI to a URL');
+
+// dynamic_javascript_include_tag()
+$t->diag('dynamic_javascript_include_tag()');
+$t->is(dynamic_javascript_include_tag('module/action'), '<script type="text/javascript" src="module/action?sf_format=js"></script>'."\n", 'dynamic_javascript_include_tag() returns a tag relative to the given action');
+$t->is(dynamic_javascript_include_tag('module/action', true), '<script type="text/javascript" src="/module/action?sf_format=js"></script>'."\n", 'dynamic_javascript_include_tag() takes an absolute boolean as its second argument');
+$t->is(dynamic_javascript_include_tag('module/action', true, array('class' => 'foo')), '<script type="text/javascript" src="/module/action?sf_format=js" class="foo"></script>'."\n", 'dynamic_javascript_include_tag() takes an array of HTML attributes as its third argument');
+
+$context->response = new sfWebResponse($context->getEventDispatcher());
+
+// use_dynamic_javascript()
+$t->diag('use_dynamic_javascript()');
+use_dynamic_javascript('module/action');
+$t->is(get_javascripts(),
+  '<script type="text/javascript" src="module/action?sf_format=js"></script>'."\n",
+  'use_dynamic_javascript() register a dynamic javascript in the response'
+);
+
+// use_dynamic_stylesheet()
+$t->diag('use_dynamic_stylesheet()');
+use_dynamic_stylesheet('module/action');
+$t->is(get_stylesheets(),
+  '<link rel="stylesheet" type="text/css" media="screen" href="module/action?sf_format=css" />'."\n", 
+  'use_dynamic_stylesheet() register a dynamic stylesheet in the response'
+);