summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrey Andreev <narf@bofh.bg>2012-06-17 01:32:31 +0200
committerAndrey Andreev <narf@bofh.bg>2012-06-17 01:32:31 +0200
commit88c47278f775413b5a408f48d30bd279e34e601a (patch)
tree748b5cdd2f9e481bcc5c640c72da6bcb436fcbd8
parent5ad6ba8dbd8ae7fcaddc2f289ddea8ce99811214 (diff)
Pagination: fixed 'rel' attribute handling, added custom attributes support, deprecated 'anchor_class' setting
-rw-r--r--system/libraries/Pagination.php86
-rw-r--r--user_guide_src/source/changelog.rst5
-rw-r--r--user_guide_src/source/libraries/pagination.rst40
3 files changed, 81 insertions, 50 deletions
diff --git a/system/libraries/Pagination.php b/system/libraries/Pagination.php
index cdec736ff..9a5a0bf62 100644
--- a/system/libraries/Pagination.php
+++ b/system/libraries/Pagination.php
@@ -67,8 +67,8 @@ class CI_Pagination {
public $page_query_string = FALSE;
public $query_string_segment = 'per_page';
public $display_pages = TRUE;
- public $anchor_class = '';
- public $attr_rel = TRUE;
+ protected $_attributes = '';
+ protected $_link_types = array();
/**
* Constructor
@@ -92,15 +92,29 @@ class CI_Pagination {
*/
public function initialize($params = array())
{
+ $attributes = array();
+
+ if (isset($params['attributes']) && is_array($params['attributes']))
+ {
+ $attributes = $params['attributes'];
+ unset($params['attributes']);
+ }
+
+ // Deprecated legacy support for the anchor_class option
+ // Should be removed in CI 3.1+
+ if (isset($params['anchor_class']))
+ {
+ empty($params['anchor_class']) OR $attributes['class'] = $params['anchor_class'];
+ unset($params['anchor_class']);
+ }
+
+ $this->_parse_attributes($attributes);
+
if (count($params) > 0)
{
foreach ($params as $key => $val)
{
- if ($key === 'anchor_class')
- {
- $this->anchor_class = ($val) ? 'class="'.$val.'" ' : '';
- }
- elseif (isset($this->$key))
+ if (isset($this->$key))
{
$this->$key = $val;
}
@@ -213,7 +227,7 @@ class CI_Pagination {
if ($this->first_link !== FALSE && $this->cur_page > ($this->num_links + 1))
{
$first_url = ($this->first_url === '') ? $this->base_url : $this->first_url;
- $output .= $this->first_tag_open.'<a '.$this->anchor_class.'href="'.$first_url.'"'.$this->_attr_rel('start').'>'
+ $output .= $this->first_tag_open.'<a href="'.$first_url.'"'.$this->_attributes.$this->_attr_rel('start').'>'
.$this->first_link.'</a>'.$this->first_tag_close;
}
@@ -224,13 +238,13 @@ class CI_Pagination {
if ($i === $base_page && $this->first_url !== '')
{
- $output .= $this->prev_tag_open.'<a '.$this->anchor_class.'href="'.$this->first_url.'"'.$this->_attr_rel('prev').'>'
+ $output .= $this->prev_tag_open.'<a href="'.$this->first_url.'"'.$this->_attributes.$this->_attr_rel('prev').'>'
.$this->prev_link.'</a>'.$this->prev_tag_close;
}
else
{
$i = ($i === $base_page) ? '' : $this->prefix.$i.$this->suffix;
- $output .= $this->prev_tag_open.'<a '.$this->anchor_class.'href="'.$this->base_url.$i.'"'.$this->_attr_rel('prev').'>'
+ $output .= $this->prev_tag_open.'<a href="'.$this->base_url.$i.'"'.$this->_attributes.$this->_attr_rel('prev').'>'
.$this->prev_link.'</a>'.$this->prev_tag_close;
}
@@ -243,7 +257,6 @@ class CI_Pagination {
for ($loop = $start -1; $loop <= $end; $loop++)
{
$i = ($this->use_page_numbers) ? $loop : ($loop * $this->per_page) - $this->per_page;
-
if ($i >= $base_page)
{
if ($this->cur_page === $loop)
@@ -253,17 +266,15 @@ class CI_Pagination {
else
{
$n = ($i === $base_page) ? '' : $i;
-
- if ($n === '' && $this->first_url !== '')
+ if ($n === '' && ! empty($this->first_url))
{
- $output .= $this->num_tag_open.'<a '.$this->anchor_class.'href="'.$this->first_url.'"'.$this->_attr_rel('start').'>'
+ $output .= $this->num_tag_open.'<a href="'.$this->first_url.'"'.$this->_attributes.$this->_attr_rel('start').'>'
.$loop.'</a>'.$this->num_tag_close;
}
else
{
$n = ($n === '') ? '' : $this->prefix.$n.$this->suffix;
-
- $output .= $this->num_tag_open.'<a '.$this->anchor_class.'href="'.$this->base_url.$n.'"'.$this->_attr_rel().'>'
+ $output .= $this->num_tag_open.'<a href="'.$this->base_url.$n.'"'.$this->_attributes.$this->_attr_rel('start').'>'
.$loop.'</a>'.$this->num_tag_close;
}
}
@@ -276,8 +287,8 @@ class CI_Pagination {
{
$i = ($this->use_page_numbers) ? $this->cur_page + 1 : $this->cur_page * $this->per_page;
- $output .= $this->next_tag_open.'<a '.$this->anchor_class.'href="'.$this->base_url.$this->prefix.$i.$this->suffix.'"'.$this->_attr_rel('next').'>'
- .$this->next_link.'</a>'.$this->next_tag_close;
+ $output .= $this->next_tag_open.'<a href="'.$this->base_url.$this->prefix.$i.$this->suffix.'"'.$this->_attributes
+ .$this->_attr_rel('next').'>'.$this->next_link.'</a>'.$this->next_tag_close;
}
// Render the "Last" link
@@ -285,7 +296,7 @@ class CI_Pagination {
{
$i = ($this->use_page_numbers) ? $num_pages : ($num_pages * $this->per_page) - $this->per_page;
- $output .= $this->last_tag_open.'<a '.$this->anchor_class.'href="'.$this->base_url.$this->prefix.$i.$this->suffix.'"'.$this->_attr_rel().'>'
+ $output .= $this->last_tag_open.'<a href="'.$this->base_url.$this->prefix.$i.$this->suffix.'"'.$this->_attributes.'>'
.$this->last_link.'</a>'.$this->last_tag_close;
}
@@ -300,23 +311,44 @@ class CI_Pagination {
// --------------------------------------------------------------------
/**
+ * Parse attributes
+ *
+ * @param array
+ * @return void
+ */
+ protected function _parse_attributes($attributes)
+ {
+ isset($attributes['rel']) OR $attributes['rel'] = TRUE;
+ $this->_link_types = ($attributes['rel'])
+ ? array('start' => 'start', 'prev' => 'prev', 'next' => 'next')
+ : array();
+ unset($attributes['rel']);
+
+ $this->_attributes = '';
+ foreach ($attributes as $key => $value)
+ {
+ $this->_attributes .= ' '.$key.'="'.$value.'"';
+ }
+ }
+
+ // --------------------------------------------------------------------
+
+ /**
* Add "rel" attribute
*
+ * @link http://www.w3.org/TR/html5/links.html#linkTypes
* @param string
* @return string
*/
- protected function _attr_rel($value = '')
+ protected function _attr_rel($type)
{
- if (empty($this->attr_rel) OR ($this->attr_rel === TRUE && empty($value)))
- {
- return '';
- }
- elseif ( ! is_bool($this->attr_rel))
+ if (isset($this->_link_types[$type]))
{
- $value = $this->attr_rel;
+ unset($this->_link_types[$type]);
+ return ' rel="'.$type.'"';
}
- return ' rel="'.$value.'"';
+ return '';
}
}
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index dd6fa4603..4054a04ff 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -162,7 +162,10 @@ Release Date: Not Released
- Added dsn (delivery status notification) option to the :doc:`Email Library <libraries/email>`.
- Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
- Added an "index" parameter to the data() method in the :doc:`Upload Library <libraries/file_uploading>`.
- - Added support for the anchor "rel" attribute in the :doc:`Pagination Library <libraries/pagination>`.
+ - :doc:`Pagination Library <libraries/pagination>` changes include:
+ - Added support for the anchor "rel" attribute.
+ - Added support for setting custom attributes.
+ - Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
- Core
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 560755fb6..c4398d739 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -247,34 +247,30 @@ adding::
$config['display_pages'] = FALSE;
-******************************
-Adding a class to every anchor
-******************************
+****************************
+Adding attributes to anchors
+****************************
-If you want to add a class attribute to every link rendered by the
-pagination class, you can set the config "anchor_class" equal to the
-classname you want.
+If you want to add an extra attribute to be added to every link rendered
+by the pagination class, you can set them as key/value pairs in the
+"attributes" config
::
- $config['anchor_class'] = 'myclass'; // class="myclass"
+ // Produces: class="myclass"
+ $config['attributes'] = array('class' => 'myclass');
-**********************************
-Changing the "rel" attribute value
-**********************************
+.. note:: Usage of the old method of setting classes via "anchor_class"
+ is deprecated.
-By default, the rel attribute will be automatically put under the
-following conditions:
+*****************************
+Disabling the "rel" attribute
+*****************************
-- rel="start" for the "first" link
-- rel="prev" for the "previous" link
-- rel="next" for the "next" link
+By default the rel attribute is dynamically generated and appended to
+the appropriate anchors. If for some reason you want to turn it off,
+you can pass boolean FALSE as a regular attribute
-If you want to disable the rel attribute, or change its value, you
-can set the 'attr_rel' config option::
-
- // Disable
- $config['attr_rel'] = FALSE;
+::
- // Use a custom value on all anchors
- $config['attr_rel'] = 'custom_value'; // produces: rel="custom_value" \ No newline at end of file
+ $config['attributes']['rel'] = FALSE; \ No newline at end of file