Changeset 2717

Timestamp:

05/29/2008 04:09:07 PM (5 months ago)

Author:

Geert

Message:

Pagination groups functionality added

Location:

trunk/system

Files:

• config/pagination.php (modified) (1 diff)
• i18n/en_US/pagination.php (modified) (1 diff)
• i18n/nl_NL/pagination.php (modified) (1 diff)
• libraries/Pagination.php (modified) (3 diffs)

trunk/system/config/pagination.php

@@ -3 +3 @@
  * @package  Pagination
  *
- * Views folder in which your pagination style templates reside.
+ * Pagination configuration is defined in groups which allows you to easily switch
+ * between different pagination settings for different website sections.
+ *
+ * Group Options:
+ *  directory      - Views folder in which your pagination style templates reside
+ *  style          - Pagination style template (matches view filename)
+ *  uri_segment    - URI segment (int or 'label') in which the current page number can be found
+ *  query_string   - Alternative to uri_segment: query string key that contains the page number
+ *  items_per_page - Number of items to display per page
+ *  auto_hide      - Automatically hides pagination for single pages
  */
-$config['directory'] = 'pagination';
-
-/**
- * Pagination style template (matches view filename).
- */
-$config['style'] = 'classic';
-
-/**
- * URI segment (or 'label') in which the current page number can be found.
- */
-$config['uri_segment'] = 3;
-
-/**
- * Number of items to display per page.
- */
-$config['items_per_page'] = 20;
-
-/**
- * Automatically hide pagination completely for single pages.
- */
-$config['auto_hide'] = FALSE;
+$config['default'] = array
+(
+        'directory'      => 'pagination',
+        'style'          => 'classic',
+        'uri_segment'    => 3,
+        'query_string'   => '',
+        'items_per_page' => 20,
+        'auto_hide'      => FALSE,
+);

trunk/system/i18n/en_US/pagination.php

@@ -3 +3 @@
 $lang = array
 (
+        'undefined_group' => 'The %s group is not defined in your pagination configuration.',
         'page'     => 'page',
         'pages'    => 'pages',

trunk/system/i18n/nl_NL/pagination.php

@@ -3 +3 @@
 $lang = array
 (
+        'undefined_group' => 'De %s groep werd niet gedefinieerd in uw pagination configuratie.',
         'page'     => 'pagina',
         'pages'    => 'pagina\'s',

trunk/system/libraries/Pagination.php

@@ -22 +22 @@
         protected $auto_hide      = FALSE;
 
-        // Automatically generated values
+        // Autogenerated values
         protected $url;
         protected $current_page;
@@ -38 +38 @@
          * Constructs and returns a new Pagination object.
          *
-         * @param   array  configuration
+         * @param   string  configuration group name
+         * @param   array   configuration items that overwrite group defaults
          * @return  object
          */
-        public function factory($config = array())
-        {
-                return new Pagination($config);
+        public function factory($group = NULL, $config = array())
+        {
+                return new Pagination($group, $config);
         }
 
@@ -49 +50 @@
          * Constructs the Pagination object.
          *
-         * @param   array  configuration
+         * @param   string  configuration group name
+         * @param   array   configuration items that overwrite group defaults
          * @return  void
          */
-        public function __construct($config = array())
-        {
-                // Load configuration
-                $config += Config::item('pagination', FALSE, FALSE);
-
+        public function __construct($group = NULL, $config = array())
+        {
+                // No group name given, only array with custom config
+                // Allows for backward compatibility as well
+                if (is_array($group))
+                {
+                        $config = $group;
+                        $group = 'default';
+                }
+                // Use default group
+                elseif ($group === NULL)
+                {
+                        $group = 'default';
+                }
+
+                // Load and validate config group
+                if ( ! is_array($group_config = Config::item('pagination.'.$group)))
+                        throw new Kohana_Exception('pagination.undefined_group', $group);
+
+                // Merge custom config items with group defaults
+                $config += $group_config;
+
+                // Pagination setup
                 $this->initialize($config);