123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784 |
- <!DOCTYPE html>
- <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
- <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <title>Pagination Class — CodeIgniter 3.1.11 documentation</title>
-
-
-
- <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
-
-
- <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
-
-
-
-
-
-
- <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
-
-
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="CodeIgniter 3.1.11 documentation" href="../index.html"/>
- <link rel="up" title="Libraries" href="index.html"/>
- <link rel="next" title="Template Parser Class" href="parser.html"/>
- <link rel="prev" title="Output Class" href="output.html"/>
-
- <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
- </head>
- <body class="wy-body-for-nav" role="document">
- <div id="nav">
- <div id="nav_inner">
-
-
-
- <div id="pulldown-menu" class="ciNav">
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
- </ul>
- </li>
- </ul>
- <ul class="current">
- <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current">
- <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
- <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li>
- <li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li>
- <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li>
- <li class="toctree-l2 current"><a class="current reference internal" href="#">Pagination Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
- <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
- </ul>
- </li>
- </ul>
- </div>
-
-
- </div>
- </div>
- <div id="nav2">
- <a href="#" id="openToc">
- <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
- </a>
- </div>
- <div class="wy-grid-for-nav">
-
- <nav data-toggle="wy-nav-shift" class="wy-nav-side">
- <div class="wy-side-nav-search">
-
- <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
-
-
- <div role="search">
- <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
- <input type="text" name="q" placeholder="Search docs" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
- </div>
- <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
- </ul>
- </li>
- </ul>
- <ul class="current">
- <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current">
- <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li>
- <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li>
- <li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li>
- <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li>
- <li class="toctree-l2 current"><a class="current reference internal" href="#">Pagination Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li>
- <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="trackback.html">Trackback Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
- <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
- </ul>
- </li>
- </ul>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
- <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
- </ul>
- </li>
- </ul>
-
-
- </div>
-
- </nav>
- <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
- <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="../index.html">CodeIgniter</a>
- </nav>
-
- <div class="wy-nav-content">
- <div class="rst-content">
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
- <li><a href="../index.html">Docs</a> »</li>
-
- <li><a href="index.html">Libraries</a> »</li>
-
- <li>Pagination Class</li>
- <li class="wy-breadcrumbs-aside">
-
- </li>
- <div style="float:right;margin-left:5px;" id="closeMe">
- <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
- </div>
- </ul>
- <hr/>
- </div>
- <div role="main" class="document">
-
- <div class="section" id="pagination-class">
- <h1>Pagination Class<a class="headerlink" href="#pagination-class" title="Permalink to this headline">¶</a></h1>
- <p>CodeIgniter’s Pagination class is very easy to use, and it is 100%
- customizable, either dynamically or via stored preferences.</p>
- <div class="contents local topic" id="contents">
- <ul class="simple">
- <li><a class="reference internal" href="#example" id="id1">Example</a><ul>
- <li><a class="reference internal" href="#notes" id="id2">Notes</a></li>
- <li><a class="reference internal" href="#setting-preferences-in-a-config-file" id="id3">Setting preferences in a config file</a></li>
- </ul>
- </li>
- <li><a class="reference internal" href="#customizing-the-pagination" id="id4">Customizing the Pagination</a></li>
- <li><a class="reference internal" href="#adding-enclosing-markup" id="id5">Adding Enclosing Markup</a></li>
- <li><a class="reference internal" href="#customizing-the-first-link" id="id6">Customizing the First Link</a></li>
- <li><a class="reference internal" href="#customizing-the-last-link" id="id7">Customizing the Last Link</a></li>
- <li><a class="reference internal" href="#customizing-the-next-link" id="id8">Customizing the “Next” Link</a></li>
- <li><a class="reference internal" href="#customizing-the-previous-link" id="id9">Customizing the “Previous” Link</a></li>
- <li><a class="reference internal" href="#customizing-the-current-page-link" id="id10">Customizing the “Current Page” Link</a></li>
- <li><a class="reference internal" href="#customizing-the-digit-link" id="id11">Customizing the “Digit” Link</a></li>
- <li><a class="reference internal" href="#hiding-the-pages" id="id12">Hiding the Pages</a></li>
- <li><a class="reference internal" href="#adding-attributes-to-anchors" id="id13">Adding attributes to anchors</a></li>
- <li><a class="reference internal" href="#disabling-the-rel-attribute" id="id14">Disabling the “rel” attribute</a></li>
- <li><a class="reference internal" href="#class-reference" id="id15">Class Reference</a></li>
- </ul>
- </div>
- <div class="custom-index container"></div><p>If you are not familiar with the term “pagination”, it refers to links
- that allows you to navigate from page to page, like this:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">«</span> <span class="nx">First </span><span class="o"><</span><span class="nx"> 1 2 3 4 5 </span><span class="o">></span><span class="nx"> Last</span> <span class="nx">»</span>
- </pre></div>
- </div>
- <div class="section" id="example">
- <h2><a class="toc-backref" href="#id1">Example</a><a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
- <p>Here is a simple example showing how to create pagination in one of your
- <a class="reference internal" href="../general/controllers.html"><span class="doc">controller</span></a> methods:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">library</span><span class="p">(</span><span class="s1">'pagination'</span><span class="p">);</span>
- <span class="nv">$config</span><span class="p">[</span><span class="s1">'base_url'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'http://example.com/index.php/test/page/'</span><span class="p">;</span>
- <span class="nv">$config</span><span class="p">[</span><span class="s1">'total_rows'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span>
- <span class="nv">$config</span><span class="p">[</span><span class="s1">'per_page'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">20</span><span class="p">;</span>
- <span class="nv">$this</span><span class="o">-></span><span class="na">pagination</span><span class="o">-></span><span class="na">initialize</span><span class="p">(</span><span class="nv">$config</span><span class="p">);</span>
- <span class="k">echo</span> <span class="nv">$this</span><span class="o">-></span><span class="na">pagination</span><span class="o">-></span><span class="na">create_links</span><span class="p">();</span>
- </pre></div>
- </div>
- <div class="section" id="notes">
- <h3><a class="toc-backref" href="#id2">Notes</a><a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h3>
- <p>The <code class="docutils literal"><span class="pre">$config</span></code> array contains your configuration variables. It is passed to
- the <code class="docutils literal"><span class="pre">$this->pagination->initialize()</span></code> method as shown above. Although
- there are some twenty items you can configure, at minimum you need the
- three shown. Here is a description of what those items represent:</p>
- <ul class="simple">
- <li><strong>base_url</strong> This is the full URL to the controller class/function
- containing your pagination. In the example above, it is pointing to a
- controller called “Test” and a function called “page”. Keep in mind
- that you can <a class="reference internal" href="../general/routing.html"><span class="doc">re-route your URI</span></a> if you
- need a different structure.</li>
- <li><strong>total_rows</strong> This number represents the total rows in the result
- set you are creating pagination for. Typically this number will be
- the total rows that your database query returned.</li>
- <li><strong>per_page</strong> The number of items you intend to show per page. In the
- above example, you would be showing 20 items per page.</li>
- </ul>
- <p>The <code class="docutils literal"><span class="pre">create_links()</span></code> method returns an empty string when there is no
- pagination to show.</p>
- </div>
- <div class="section" id="setting-preferences-in-a-config-file">
- <h3><a class="toc-backref" href="#id3">Setting preferences in a config file</a><a class="headerlink" href="#setting-preferences-in-a-config-file" title="Permalink to this headline">¶</a></h3>
- <p>If you prefer not to set preferences using the above method, you can
- instead put them into a config file. Simply create a new file called
- pagination.php, add the <code class="docutils literal"><span class="pre">$config</span></code> array in that file. Then save the file
- in <em>application/config/pagination.php</em> and it will be used automatically.
- You will NOT need to use <code class="docutils literal"><span class="pre">$this->pagination->initialize()</span></code> if you save
- your preferences in a config file.</p>
- </div>
- </div>
- <div class="section" id="customizing-the-pagination">
- <h2><a class="toc-backref" href="#id4">Customizing the Pagination</a><a class="headerlink" href="#customizing-the-pagination" title="Permalink to this headline">¶</a></h2>
- <p>The following is a list of all the preferences you can pass to the
- initialization function to tailor the display.</p>
- <p><strong>$config[‘uri_segment’] = 3;</strong></p>
- <p>The pagination function automatically determines which segment of your
- URI contains the page number. If you need something different you can
- specify it.</p>
- <p><strong>$config[‘num_links’] = 2;</strong></p>
- <p>The number of “digit” links you would like before and after the selected
- page number. For example, the number 2 will place two digits on either
- side, as in the example links at the very top of this page.</p>
- <p><strong>$config[‘use_page_numbers’] = TRUE;</strong></p>
- <p>By default, the URI segment will use the starting index for the items
- you are paginating. If you prefer to show the the actual page number,
- set this to TRUE.</p>
- <p><strong>$config[‘page_query_string’] = TRUE;</strong></p>
- <p>By default, the pagination library assume you are using <a class="reference internal" href="../general/urls.html"><span class="doc">URI
- Segments</span></a>, and constructs your links something
- like:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">http</span><span class="o">://</span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">test</span><span class="o">/</span><span class="nx">page</span><span class="o">/</span><span class="mi">20</span>
- </pre></div>
- </div>
- <p>If you have <code class="docutils literal"><span class="pre">$config['enable_query_strings']</span></code> set to TRUE your links
- will automatically be re-written using Query Strings. This option can
- also be explicitly set. Using <code class="docutils literal"><span class="pre">$config['page_query_string']</span></code> set to TRUE,
- the pagination link will become:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">http</span><span class="o">://</span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">?</span><span class="nx">c</span><span class="o">=</span><span class="nx">test</span><span class="o">&</span><span class="nx">m</span><span class="o">=</span><span class="nx">page</span><span class="o">&</span><span class="nx">per_page</span><span class="o">=</span><span class="mi">20</span>
- </pre></div>
- </div>
- <p>Note that “per_page” is the default query string passed, however can be
- configured using <code class="docutils literal"><span class="pre">$config['query_string_segment']</span> <span class="pre">=</span> <span class="pre">'your_string'</span></code></p>
- <p><strong>$config[‘reuse_query_string’] = FALSE;</strong></p>
- <p>By default your Query String arguments (nothing to do with other
- query string options) will be ignored. Setting this config to
- TRUE will add existing query string arguments back into the
- URL after the URI segment and before the suffix.:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">http</span><span class="o">://</span><span class="nx">example</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">index</span><span class="o">.</span><span class="nx">php</span><span class="o">/</span><span class="nx">test</span><span class="o">/</span><span class="nx">page</span><span class="o">/</span><span class="mi">20</span><span class="o">?</span><span class="nx">query</span><span class="o">=</span><span class="nx">search</span><span class="o">%</span><span class="nx">term</span>
- </pre></div>
- </div>
- <p>This helps you mix together normal <a class="reference internal" href="../general/urls.html"><span class="doc">URI Segments</span></a>
- as well as query string arguments, which until 3.0 was not possible.</p>
- <p><strong>$config[‘prefix’] = ‘’;</strong></p>
- <p>A custom prefix added to the path. The prefix value will be right before
- the offset segment.</p>
- <p><strong>$config[‘suffix’] = ‘’;</strong></p>
- <p>A custom suffix added to the path. The suffix value will be right after
- the offset segment.</p>
- <p><strong>$config[‘use_global_url_suffix’] = FALSE;</strong></p>
- <p>When set to TRUE, it will <strong>override</strong> the <code class="docutils literal"><span class="pre">$config['suffix']</span></code> value and
- instead set it to the one that you have in <code class="docutils literal"><span class="pre">$config['url_suffix']</span></code> in
- your <strong>application/config/config.php</strong> file.</p>
- </div>
- <div class="section" id="adding-enclosing-markup">
- <h2><a class="toc-backref" href="#id5">Adding Enclosing Markup</a><a class="headerlink" href="#adding-enclosing-markup" title="Permalink to this headline">¶</a></h2>
- <p>If you would like to surround the entire pagination with some markup you
- can do it with these two preferences:</p>
- <p><strong>$config[‘full_tag_open’] = ‘<p>’;</strong></p>
- <p>The opening tag placed on the left side of the entire result.</p>
- <p><strong>$config[‘full_tag_close’] = ‘</p>’;</strong></p>
- <p>The closing tag placed on the right side of the entire result.</p>
- </div>
- <div class="section" id="customizing-the-first-link">
- <h2><a class="toc-backref" href="#id6">Customizing the First Link</a><a class="headerlink" href="#customizing-the-first-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘first_link’] = ‘First’;</strong></p>
- <p>The text you would like shown in the “first” link on the left. If you do
- not want this link rendered, you can set its value to FALSE.</p>
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p class="last">This value can also be translated via a language file.</p>
- </div>
- <p><strong>$config[‘first_tag_open’] = ‘<div>’;</strong></p>
- <p>The opening tag for the “first” link.</p>
- <p><strong>$config[‘first_tag_close’] = ‘</div>’;</strong></p>
- <p>The closing tag for the “first” link.</p>
- <p><strong>$config[‘first_url’] = ‘’;</strong></p>
- <p>An alternative URL to use for the “first page” link.</p>
- </div>
- <div class="section" id="customizing-the-last-link">
- <h2><a class="toc-backref" href="#id7">Customizing the Last Link</a><a class="headerlink" href="#customizing-the-last-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘last_link’] = ‘Last’;</strong></p>
- <p>The text you would like shown in the “last” link on the right. If you do
- not want this link rendered, you can set its value to FALSE.</p>
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p class="last">This value can also be translated via a language file.</p>
- </div>
- <p><strong>$config[‘last_tag_open’] = ‘<div>’;</strong></p>
- <p>The opening tag for the “last” link.</p>
- <p><strong>$config[‘last_tag_close’] = ‘</div>’;</strong></p>
- <p>The closing tag for the “last” link.</p>
- </div>
- <div class="section" id="customizing-the-next-link">
- <h2><a class="toc-backref" href="#id8">Customizing the “Next” Link</a><a class="headerlink" href="#customizing-the-next-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘next_link’] = ‘&gt;’;</strong></p>
- <p>The text you would like shown in the “next” page link. If you do not
- want this link rendered, you can set its value to FALSE.</p>
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p class="last">This value can also be translated via a language file.</p>
- </div>
- <p><strong>$config[‘next_tag_open’] = ‘<div>’;</strong></p>
- <p>The opening tag for the “next” link.</p>
- <p><strong>$config[‘next_tag_close’] = ‘</div>’;</strong></p>
- <p>The closing tag for the “next” link.</p>
- </div>
- <div class="section" id="customizing-the-previous-link">
- <h2><a class="toc-backref" href="#id9">Customizing the “Previous” Link</a><a class="headerlink" href="#customizing-the-previous-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘prev_link’] = ‘&lt;’;</strong></p>
- <p>The text you would like shown in the “previous” page link. If you do not
- want this link rendered, you can set its value to FALSE.</p>
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p class="last">This value can also be translated via a language file.</p>
- </div>
- <p><strong>$config[‘prev_tag_open’] = ‘<div>’;</strong></p>
- <p>The opening tag for the “previous” link.</p>
- <p><strong>$config[‘prev_tag_close’] = ‘</div>’;</strong></p>
- <p>The closing tag for the “previous” link.</p>
- </div>
- <div class="section" id="customizing-the-current-page-link">
- <h2><a class="toc-backref" href="#id10">Customizing the “Current Page” Link</a><a class="headerlink" href="#customizing-the-current-page-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘cur_tag_open’] = ‘<b>’;</strong></p>
- <p>The opening tag for the “current” link.</p>
- <p><strong>$config[‘cur_tag_close’] = ‘</b>’;</strong></p>
- <p>The closing tag for the “current” link.</p>
- </div>
- <div class="section" id="customizing-the-digit-link">
- <h2><a class="toc-backref" href="#id11">Customizing the “Digit” Link</a><a class="headerlink" href="#customizing-the-digit-link" title="Permalink to this headline">¶</a></h2>
- <p><strong>$config[‘num_tag_open’] = ‘<div>’;</strong></p>
- <p>The opening tag for the “digit” link.</p>
- <p><strong>$config[‘num_tag_close’] = ‘</div>’;</strong></p>
- <p>The closing tag for the “digit” link.</p>
- </div>
- <div class="section" id="hiding-the-pages">
- <h2><a class="toc-backref" href="#id12">Hiding the Pages</a><a class="headerlink" href="#hiding-the-pages" title="Permalink to this headline">¶</a></h2>
- <p>If you wanted to not list the specific pages (for example, you only want
- “next” and “previous” links), you can suppress their rendering by
- adding:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">'display_pages'</span><span class="p">]</span> <span class="o">=</span> <span class="k">FALSE</span><span class="p">;</span>
- </pre></div>
- </div>
- </div>
- <div class="section" id="adding-attributes-to-anchors">
- <h2><a class="toc-backref" href="#id13">Adding attributes to anchors</a><a class="headerlink" href="#adding-attributes-to-anchors" title="Permalink to this headline">¶</a></h2>
- <p>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:</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1">// Produces: class="myclass"</span>
- <span class="nv">$config</span><span class="p">[</span><span class="s1">'attributes'</span><span class="p">]</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'myclass'</span><span class="p">);</span>
- </pre></div>
- </div>
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p class="last">Usage of the old method of setting classes via “anchor_class”
- is deprecated.</p>
- </div>
- </div>
- <div class="section" id="disabling-the-rel-attribute">
- <h2><a class="toc-backref" href="#id14">Disabling the “rel” attribute</a><a class="headerlink" href="#disabling-the-rel-attribute" title="Permalink to this headline">¶</a></h2>
- <p>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</p>
- <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">'attributes'</span><span class="p">][</span><span class="s1">'rel'</span><span class="p">]</span> <span class="o">=</span> <span class="k">FALSE</span><span class="p">;</span>
- </pre></div>
- </div>
- </div>
- <div class="section" id="class-reference">
- <h2><a class="toc-backref" href="#id15">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline">¶</a></h2>
- <dl class="class">
- <dt id="CI_Pagination">
- <em class="property">class </em><code class="descname">CI_Pagination</code><a class="headerlink" href="#CI_Pagination" title="Permalink to this definition">¶</a></dt>
- <dd><dl class="method">
- <dt id="CI_Pagination::initialize">
- <code class="descname">initialize</code><span class="sig-paren">(</span><span class="optional">[</span><em>$params = array()</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Pagination::initialize" title="Permalink to this definition">¶</a></dt>
- <dd><table class="docutils field-list" frame="void" rules="none">
- <col class="field-name" />
- <col class="field-body" />
- <tbody valign="top">
- <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
- <li><strong>$params</strong> (<em>array</em>) – Configuration parameters</li>
- </ul>
- </td>
- </tr>
- <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">CI_Pagination instance (method chaining)</p>
- </td>
- </tr>
- <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">CI_Pagination</p>
- </td>
- </tr>
- </tbody>
- </table>
- <p>Initializes the Pagination class with your preferred options.</p>
- </dd></dl>
- <dl class="method">
- <dt id="CI_Pagination::create_links">
- <code class="descname">create_links</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Pagination::create_links" title="Permalink to this definition">¶</a></dt>
- <dd><table class="docutils field-list" frame="void" rules="none">
- <col class="field-name" />
- <col class="field-body" />
- <tbody valign="top">
- <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">HTML-formatted pagination</td>
- </tr>
- <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
- </tr>
- </tbody>
- </table>
- <p>Returns a “pagination” bar, containing the generated links or an empty string if there’s just a single page.</p>
- </dd></dl>
- </dd></dl>
- </div>
- </div>
- </div>
- <footer>
-
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
- <a href="parser.html" class="btn btn-neutral float-right" title="Template Parser Class">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
- <a href="output.html" class="btn btn-neutral" title="Output Class"><span class="fa fa-arrow-circle-left"></span> Previous</a>
-
- </div>
-
- <hr/>
- <div role="contentinfo">
- <p>
- © Copyright 2014 - 2019, British Columbia Institute of Technology.
- Last updated on Sep 19, 2019.
- </p>
- </div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
-
- </footer>
- </div>
- </div>
- </section>
- </div>
-
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT:'../',
- VERSION:'3.1.11',
- COLLAPSE_INDEX:false,
- FILE_SUFFIX:'.html',
- HAS_SOURCE: false
- };
- </script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
-
-
-
- <script type="text/javascript" src="../_static/js/theme.js"></script>
-
-
-
- <script type="text/javascript">
- jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
- });
- </script>
-
- </body>
- </html>
|