From d5968378ace8c13bf1d4b9d8365d725de76e0d75 Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Thu, 22 Jan 2009 03:56:12 +0000
Subject: [PATCH] #345973 by aaron and Rob Loach: Move parameter on
drupal_add_css/js to a 'type' instead, to clean up calling code.
---
includes/common.inc | 56 +++++++++++++++-------------
modules/simpletest/tests/common.test | 14 +++++--
2 files changed, 42 insertions(+), 28 deletions(-)
diff --git a/includes/common.inc b/includes/common.inc
index 8c0dd1311e54..66d41bb9cc5d 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -1987,13 +1987,17 @@ function drupal_add_link($attributes) {
* file added to the list, if exists in the same directory. This CSS file
* should contain overrides for properties which should be reversed or
* otherwise different in a right-to-left display.
+ *
+ * Note that if $options or $options['type'] is 'reset', then $path will be
+ * ignored.
* @param $options
* (optional) A string defining the type of CSS that is being added in the
* $path parameter ('module' or 'theme'), or an associative array of
* additional options, with the following keys:
* - 'type'
- * The type of stylesheet that is being added. Types are: module or
- * theme. Defaults to 'module'.
+ * The type of stylesheet that is being added. Types are: 'module',
+ * 'theme', or 'reset'. Defaults to 'module'. If the type is 'reset',
+ * then the CSS will be reset, ignoring $path and other $options.
* - 'media'
* The media type for the stylesheet, e.g., all, print, screen. Defaults
* to 'all'.
@@ -2020,32 +2024,31 @@ function drupal_add_link($attributes) {
*
* Typical candidates for caching are for example styles for nodes across
* the site, or used in the theme.
- * @param $reset
- * (optional) Resets the currently loaded cascading stylesheets.
* @return
* An array of CSS files.
*/
-function drupal_add_css($path = NULL, $options = NULL, $reset = FALSE) {
+function drupal_add_css($path = NULL, $options = NULL) {
static $css = array();
global $language;
+ // Construct the options, taking the defaults into consideration.
+ if (isset($options)) {
+ if (!is_array($options)) {
+ $options = array('type' => $options);
+ }
+ }
+ else {
+ $options = array();
+ }
+
// Request made to reset the CSS added so far.
- if ($reset) {
- $css = array();
+ if (isset($options['type']) && $options['type'] == 'reset') {
+ return $css = array();
}
// Create an array of CSS files for each media type first, since each type needs to be served
// to the browser differently.
if (isset($path)) {
- // Construct the options, taking the defaults into consideration.
- if (isset($options)) {
- if (!is_array($options)) {
- $options = array('type' => $options);
- }
- }
- else {
- $options = array();
- }
$options += array(
'type' => 'module',
'media' => 'all',
@@ -2347,6 +2350,8 @@ function drupal_clear_css_cache() {
* array is directly placed in Drupal.settings. All modules should wrap
* their actual configuration settings in another variable to prevent
* the pollution of the Drupal.settings namespace.
+ * - 'reset': Anything in $data will be ignored and the JavaScript added so
+ * far will be reset.
* @param $options
* (optional) A string defining the type of JavaScript that is being added
* in the $data parameter ('file'/'setting'/'inline'), or an array which
@@ -2354,7 +2359,10 @@ function drupal_clear_css_cache() {
* always pass the string 'setting' only.
* - type
* The type of JavaScript that is to be added to the page. Allowed
- * values are 'file', 'inline' or 'setting'. Defaults to 'file'.
+ * values are 'file', 'inline', 'setting', or 'reset'. Defaults to
+ * 'file'. Note that if type is 'reset', then $data and all other
+ * $options will be ignored and the JavaScript added so far will be
+ * reset.
* - scope
* The location in which you want to place the script. Possible values
* are 'header' or 'footer'. If your theme implements different regions,
@@ -2387,13 +2395,11 @@ function drupal_clear_css_cache() {
* - preprocess
* Aggregate the JavaScript if the JavaScript optimization setting has
* been toggled in admin/settings/performance. Defaults to TRUE.
- * @param $reset
- * (optional) Resets the currently loaded JavaScript.
* @return
* The contructed array of JavaScript files.
* @see drupal_get_js()
*/
-function drupal_add_js($data = NULL, $options = NULL, $reset = FALSE) {
+function drupal_add_js($data = NULL, $options = NULL) {
static $javascript = array();
// Construct the options, taking the defaults into consideration.
@@ -2407,14 +2413,14 @@ function drupal_add_js($data = NULL, $options = NULL, $reset = FALSE) {
}
$options += drupal_js_defaults($data);
+ if ($options['type'] == 'reset') {
+ // Request made to reset the JavaScript added so far
+ return $javascript = array();
+ }
+
// Preprocess can only be set if caching is enabled.
$options['preprocess'] = $options['cache'] ? $options['preprocess'] : FALSE;
- // Request made to reset the JavaScript added so far.
- if ($reset) {
- $javascript = array();
- }
-
if (isset($data)) {
// Add jquery.js and drupal.js, as well as the basePath setting, the
// first time a Javascript file is added.
diff --git a/modules/simpletest/tests/common.test b/modules/simpletest/tests/common.test
index 8f0ede2905f2..78dc9f7698b9 100644
--- a/modules/simpletest/tests/common.test
+++ b/modules/simpletest/tests/common.test
@@ -170,7 +170,7 @@ class CascadingStylesheetsTestCase extends DrupalWebTestCase {
function setUp() {
parent::setUp();
// Reset drupal_add_css() before each test.
- drupal_add_css(NULL, NULL, TRUE);
+ drupal_add_css(NULL, 'reset');
}
/**
@@ -189,6 +189,14 @@ class CascadingStylesheetsTestCase extends DrupalWebTestCase {
$this->assertEqual($css['all']['module'][$path], TRUE, t('Adding a CSS file caches it properly.'));
}
+ /**
+ * Makes sure that reseting the CSS empties the cache.
+ */
+ function testReset() {
+ drupal_add_css(NULL, 'reset');
+ $this->assertEqual(array(), drupal_add_css(), t('Resetting the CSS empties the cache.'));
+ }
+
/**
* Tests rendering the stylesheets.
*/
@@ -352,7 +360,7 @@ class JavaScriptTestCase extends DrupalWebTestCase {
variable_set('preprocess_js', 0);
// Reset drupal_add_js() before each test.
- drupal_add_js(NULL, NULL, TRUE);
+ drupal_add_js(NULL, 'reset');
}
function tearDown() {
@@ -404,7 +412,7 @@ class JavaScriptTestCase extends DrupalWebTestCase {
*/
function testReset() {
drupal_add_js('misc/collapse.js');
- drupal_add_js(NULL, NULL, TRUE);
+ drupal_add_js(NULL, 'reset');
$this->assertEqual(array(), drupal_add_js(), t('Resetting the JavaScript correctly empties the cache.'));
}
--
GitLab