Changeset 2865

Timestamp:

11/24/08 05:24:59 (7 weeks ago)

Author:

ringmaster

Message:

Stacks now support the $after parameter. Setting the $after parameter lets you name one or more named stack entries after which a new stack entry will appear. So if you add a new stack with Stack::add('admin_header_javascript', $output, 'podcast', array('jquery', 'ui.tabs')); then the 'podcast' entry will be inserted after both the 'jquery' and the 'ui.tabs' items.

Also, Stack::scripts() and Stack::styles() have been added which allow Stack::add() to be called to add both URL-referenced and inline styles. For example, you can now call this to add an inline script after jquery is loaded: Stack::add('admin_header_javascript', '$(function(){alert("on load");});', 'my alert', 'jquery');

Referenced URLs added to these stacks must be absolute URLs, starting with 'http://'

This should eliminate the need for the 'admin_header_after' hook.

Location:

trunk/htdocs/system

Files:

• admin/header.php (modified) (2 diffs)
• classes/adminhandler.php (modified) (3 diffs)
• classes/stack.php (modified) (14 diffs)

trunk/htdocs/system/admin/header.php

@@ -20 +20 @@
     <?php
         Plugins::act( 'admin_header', $this );
-        Stack::out( 'admin_header_javascript', '<script src="%s" type="text/javascript"></script>'."\r\n" );
-        Stack::out( 'admin_stylesheet', '<link rel="stylesheet" type="text/css" href="%s" media="%s">'."\r\n" );
+        Stack::out( 'admin_header_javascript', array('Stack', 'scripts') );
+        Stack::out( 'admin_stylesheet', array('Stack', 'styles') );
     ?>
     <!--[if IE 7]>
@@ -69 +69 @@
 
 <?php Plugins::act('admin_info', $theme, $page); ?>
-

trunk/htdocs/system/classes/adminhandler.php

@@ -2202 +2202 @@
         echo json_encode($output);
     }
-    
+
     public function ajax_update_groups($handler_vars)
     {
@@ -2399 +2399 @@
         $users= Users::get_all();
         $members= $group->members;
-        foreach($users as $user) {          
+        foreach($users as $user) {
             if(in_array($user->id, $members)) {
                 $user->membership= TRUE;
@@ -2716 +2716 @@
      */
     public static function setup_stacks() {
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.core.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.slider.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.tabs.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.sortable.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.resizable.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.spinner.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.color.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('habari') . "/3rdparty/humanmsg/humanmsg.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('habari') . "/3rdparty/hotkeys/jquery.hotkeys.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('admin_theme') . "/js/media.js" );
-        Stack::add( 'admin_header_javascript', Site::get_url('admin_theme') . "/js/admin.js" );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.js", 'jquery' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.core.js", 'ui.core' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.slider.js", 'ui.slider' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.tabs.js", 'ui.tabs' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.sortable.js", 'ui.sortable' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/ui.resizable.js", 'ui.resizable' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.spinner.js", 'jquery.spinner' );
+        Stack::add( 'admin_header_javascript', Site::get_url('scripts') . "/jquery.color.js", 'jquery.color' );
+        Stack::add( 'admin_header_javascript', Site::get_url('habari') . "/3rdparty/humanmsg/humanmsg.js", 'humanmsg' );
+        Stack::add( 'admin_header_javascript', Site::get_url('habari') . "/3rdparty/hotkeys/jquery.hotkeys.js", 'jquery.hotkeys' );
+        Stack::add( 'admin_header_javascript', Site::get_url('admin_theme') . "/js/media.js", 'media' );
+        Stack::add( 'admin_header_javascript', Site::get_url('admin_theme') . "/js/admin.js", 'admin' );
     }
 }

trunk/htdocs/system/classes/stack.php

@@ -7 +7 @@
  * This is useful for collecting a set of unique javascript references to output
  * and then insert them at a specific point on the page.
- * 
+ *
  * <code>
- * // Add jquery to the javascript stack: 
+ * // Add jquery to the javascript stack:
  * Stack::add( 'template_header_javascript', Site::get_url('scripts') . '/jquery.js', 'jquery' );
  *
  * // Add stylesheet to theme_stylesheet stack with media type
  * Stack::add( 'template_stylesheet', array( Site::get_url('theme') . '/style.css', 'screen' ), 'style' );
- *  
+ *
  * // Output the javascript stack:
  * Stack::out( 'template_header_javascript', '<script src="%s" type="text/javascript"></script>' );
@@ -20 +20 @@
  * // Output the theme_stylesheet stack:
  * Stack::out( 'template_stylesheet', '<link rel="stylesheet" type="text/css"  href="%s" media="%s">' );
- * </code>   
+ * </code>
  *
  * @package Habari
@@ -28 +28 @@
 {
     private static $stacks = array();
-    
+
     /**
      * Private constructor for Stack.
-     * Stack objects should only be created using the static 
+     * Stack objects should only be created using the static
      * method Static::create_stack(), or one of the methods that
-     * adds a value directly to a stack.  This prevents multiple Stack 
+     * adds a value directly to a stack.  This prevents multiple Stack
      * objects from being created with the same name.
-     * 
+     *
      * @param mixed $input An array or ArrayObject to create the stack from.
      * @return array The created stack
@@ -48 +48 @@
      * @param string $stack_name The name of the stack to return
      * @return Stack The requested stack
-     **/                
+     **/
     public static function get_named_stack( $stack_name )
     {
@@ -58 +58 @@
         }
     }
-    
+
     /**
      * Check for the existence of a given stack item.
@@ -67 +67 @@
      */
     public static function has ( $stack_name, $value_name ) {
-        
+
         // get the stack
         $stack = self::get_named_stack( $stack_name );
-        
+
         if ( isset( $stack[ $value_name ] ) ) {
             return true;
@@ -77 +77 @@
             return false;
         }
-        
-    }
-    
+
+    }
+
     /**
      * Get a single item from a given stack.
@@ -89 +89 @@
      */
     public static function get_item ( $stack_name, $value_name, $default_value = null ) {
-        
+
         // get the stack
         $stack = self::get_named_stack( $stack_name );
-        
+
         if ( isset( $stack[ $value_name ] ) ) {
             return $stack[ $value_name ];
@@ -99 +99 @@
             return $default_value;
         }
-        
-    }
-    
+
+    }
+
     /**
      * Creates and retreives a named stack instance
      * @param string $stack_name The name of the stack to create and return
      * @return array The created stack
-     **/                
+     **/
     public static function create_stack( $stack_name )
     {
@@ -115 +115 @@
         return self::$stacks[$stack_name];
     }
-    
+
     /**
      * Add a value to a stack
@@ -121 +121 @@
      * @param mixed $value The value to add
      * @param string $value_name The name of the value to add
-     * @return array The stack that was added to     
-     **/     
-    public static function add( $stack_name, $value, $value_name = null )
+     * @return array The stack that was added to
+     **/
+    public static function add( $stack_name, $value, $value_name = null, $after = null )
     {
         $stack = self::get_named_stack( $stack_name );
         $value_name = $value_name ? $value_name : md5( serialize( $value ) );
-        $stack[$value_name]= $value;
+        if(!is_null($after)) {
+            if(!is_array($after)) {
+                $after = array($after);
+            }
+            $newstack = array();
+            foreach($stack as $k => $v) {
+                $newstack[$k] = $v;
+                $inserted = false;
+                if(in_array($k, $after)) {
+                    unset($after[array_search($k, $after)]);
+                    if(count($after) == 0) {
+                        $newstack[$value_name] = $value;
+                        $inserted = true;
+                    }
+                }
+            }
+            if(!$inserted) {
+                $newstack[$value_name] = $value;
+            }
+            $stack = $newstack;
+        }
+        else {
+            $stack[$value_name]= $value;
+        }
         self::$stacks[$stack_name]= $stack;
         return $stack;
     }
-    
+
     /**
      * Remove a value to a stack
      * @param string $stack_name The name of the stack
      * @param string $value_name The name of the value to remove
-     * @return array The rest of the stack, post-remove  
-     **/     
+     * @return array The rest of the stack, post-remove
+     **/
     public static function remove( $stack_name, $value_name )
     {
@@ -147 +170 @@
         return $stack;
     }
-    
+
     /**
      * Returns all of the values of the stack
      * @param string $stack_name The name of the stack to output
      * @param mixed $format A printf-style formatting string or callback used to output each stack element
-     **/         
+     **/
     public static function get( $stack_name, $format = null)
     {
@@ -160 +183 @@
         foreach( $stack as $element ) {
             if ( is_callable($format) ) {
-                $out.= call_user_func_array( $format, (array) $element ); 
+                $out.= call_user_func_array( $format, (array) $element );
             }
             elseif ( is_string( $format ) ) {
@@ -171 +194 @@
         return $out;
     }
-    
+
     /**
      * Outputs all of the values of the stack
      * @param string $stack_name The name of the stack to output
      * @param mixed $format A printf-style formatting string or callback used to output each stack element
-     **/         
+     **/
     public static function out( $stack_name, $format = null)
     {
         echo self::get( $stack_name, $format );
     }
+
+    public static function scripts( $element )
+    {
+        if(strpos($element, 'http://') === 0 && strpos($element, "\n") === FALSE) {
+            $output = sprintf( '<script src="%s" type="text/javascript"></script>'."\r\n", $element);
+        }
+        else {
+            $output = sprintf( '<script type="text/javascript">%s</script>'."\r\n", $element);
+        }
+        return $output;
+    }
+
+    public static function styles( $element, $typename )
+    {
+        if(strpos($element, 'http://') === 0 && strpos($element, "\n") === FALSE) {
+            $output = sprintf( '<link rel="stylesheet" type="text/css" href="%s" media="%s">'."\r\n", $element, $typename);
+        }
+        else {
+            $output = sprintf( '<style type="text/stylesheet" media="%s">%s</style>'."\r\n", $typename, $element);
+        }
+        return $output;
+    }
 }