Andrey Andreev | c576995 | 2019-01-16 17:49:35 +0200 | [diff] [blame] | 1 | |
| 2 | |
| 3 | <!DOCTYPE html> |
| 4 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| 5 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| 6 | <head> |
| 7 | <meta charset="utf-8"> |
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 9 | |
| 10 | <title>Trackback Class — CodeIgniter 3.1.10 documentation</title> |
| 11 | |
| 12 | |
| 13 | |
| 14 | |
| 15 | <link rel="shortcut icon" href="../_static/ci-icon.ico"/> |
| 16 | |
| 17 | |
| 18 | |
| 19 | <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'> |
| 20 | |
| 21 | |
| 22 | |
| 23 | |
| 24 | |
| 25 | |
| 26 | |
| 27 | |
| 28 | |
| 29 | <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" /> |
| 30 | |
| 31 | |
| 32 | |
| 33 | <link rel="index" title="Index" |
| 34 | href="../genindex.html"/> |
| 35 | <link rel="search" title="Search" href="../search.html"/> |
| 36 | <link rel="top" title="CodeIgniter 3.1.10 documentation" href="../index.html"/> |
| 37 | <link rel="up" title="Libraries" href="index.html"/> |
| 38 | <link rel="next" title="Typography Class" href="typography.html"/> |
| 39 | <link rel="prev" title="HTML Table Class" href="table.html"/> |
| 40 | |
| 41 | |
| 42 | <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> |
| 43 | |
| 44 | </head> |
| 45 | |
| 46 | <body class="wy-body-for-nav" role="document"> |
| 47 | |
| 48 | <div id="nav"> |
| 49 | <div id="nav_inner"> |
| 50 | |
| 51 | |
| 52 | |
| 53 | <div id="pulldown-menu" class="ciNav"> |
| 54 | <ul> |
| 55 | <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li> |
| 56 | </ul> |
| 57 | <ul> |
| 58 | <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> |
| 59 | <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> |
| 60 | <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li> |
| 61 | <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li> |
| 62 | <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li> |
| 63 | </ul> |
| 64 | </li> |
| 65 | </ul> |
| 66 | <ul> |
| 67 | <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> |
| 68 | <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> |
| 69 | <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> |
| 70 | <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> |
| 71 | <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> |
| 72 | <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> |
| 73 | <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> |
| 74 | </ul> |
| 75 | </li> |
| 76 | </ul> |
| 77 | <ul> |
| 78 | <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul> |
| 79 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li> |
| 80 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li> |
| 81 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li> |
| 82 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li> |
| 83 | </ul> |
| 84 | </li> |
| 85 | </ul> |
| 86 | <ul> |
| 87 | <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> |
| 90 | </ul> |
| 91 | </li> |
| 92 | </ul> |
| 93 | <ul> |
| 94 | <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul> |
| 95 | <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li> |
| 96 | <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li> |
| 97 | <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li> |
| 98 | <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li> |
| 99 | <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li> |
| 100 | <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li> |
| 101 | <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li> |
| 102 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li> |
| 103 | <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li> |
| 104 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li> |
| 105 | <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li> |
| 106 | <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li> |
| 107 | <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li> |
| 108 | <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li> |
| 109 | <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li> |
| 110 | <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li> |
| 111 | <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li> |
| 112 | <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li> |
| 113 | <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li> |
| 114 | <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li> |
| 115 | <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li> |
| 116 | <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li> |
| 117 | <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li> |
| 118 | <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li> |
| 119 | <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li> |
| 120 | <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li> |
| 121 | </ul> |
| 122 | </li> |
| 123 | </ul> |
| 124 | <ul class="current"> |
| 125 | <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current"> |
| 126 | <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li> |
| 127 | <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li> |
| 128 | <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li> |
| 129 | <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li> |
| 130 | <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li> |
| 131 | <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li> |
| 132 | <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li> |
| 133 | <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li> |
| 134 | <li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li> |
| 135 | <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li> |
| 136 | <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li> |
| 137 | <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li> |
| 138 | <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li> |
| 139 | <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li> |
| 140 | <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li> |
| 141 | <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li> |
| 142 | <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li> |
| 143 | <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li> |
| 144 | <li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li> |
| 145 | <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li> |
| 146 | <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li> |
| 147 | <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li> |
| 148 | <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li> |
| 149 | <li class="toctree-l2 current"><a class="current reference internal" href="#">Trackback Class</a></li> |
| 150 | <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li> |
| 151 | <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li> |
| 152 | <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li> |
| 153 | <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li> |
| 154 | <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> |
| 155 | <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li> |
| 156 | </ul> |
| 157 | </li> |
| 158 | </ul> |
| 159 | <ul> |
| 160 | <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul> |
| 161 | <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li> |
| 162 | <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li> |
| 163 | <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li> |
| 164 | <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li> |
| 165 | <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li> |
| 166 | <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li> |
| 167 | <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li> |
| 168 | <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li> |
| 169 | <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li> |
| 170 | <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li> |
| 171 | <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li> |
| 172 | <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> |
| 173 | <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> |
| 174 | <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> |
| 175 | </ul> |
| 176 | </li> |
| 177 | </ul> |
| 178 | <ul> |
| 179 | <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul> |
| 180 | <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li> |
| 181 | <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li> |
| 182 | <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li> |
| 183 | <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li> |
| 184 | <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li> |
| 185 | <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> |
| 186 | <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> |
| 187 | <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li> |
| 188 | <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li> |
| 189 | <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li> |
| 190 | <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li> |
| 191 | <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li> |
| 192 | <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li> |
| 193 | <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li> |
| 194 | <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li> |
| 195 | <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li> |
| 196 | <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li> |
| 197 | <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li> |
| 198 | <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li> |
| 199 | <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li> |
| 200 | <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li> |
| 201 | </ul> |
| 202 | </li> |
| 203 | </ul> |
| 204 | |
| 205 | </div> |
| 206 | |
| 207 | |
| 208 | </div> |
| 209 | </div> |
| 210 | <div id="nav2"> |
| 211 | <a href="#" id="openToc"> |
| 212 | <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" /> |
| 213 | </a> |
| 214 | </div> |
| 215 | |
| 216 | <div class="wy-grid-for-nav"> |
| 217 | |
| 218 | |
| 219 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 220 | <div class="wy-side-nav-search"> |
| 221 | |
| 222 | <a href="../index.html" class="fa fa-home"> CodeIgniter</a> |
| 223 | |
| 224 | |
| 225 | <div role="search"> |
| 226 | <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| 227 | <input type="text" name="q" placeholder="Search docs" /> |
| 228 | <input type="hidden" name="check_keywords" value="yes" /> |
| 229 | <input type="hidden" name="area" value="default" /> |
| 230 | </form> |
| 231 | </div> |
| 232 | </div> |
| 233 | |
| 234 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| 235 | |
| 236 | |
| 237 | |
| 238 | <ul> |
| 239 | <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li> |
| 240 | </ul> |
| 241 | <ul> |
| 242 | <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul> |
| 243 | <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li> |
| 244 | <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li> |
| 245 | <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li> |
| 246 | <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li> |
| 247 | </ul> |
| 248 | </li> |
| 249 | </ul> |
| 250 | <ul> |
| 251 | <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul> |
| 252 | <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li> |
| 253 | <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li> |
| 254 | <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li> |
| 255 | <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li> |
| 256 | <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li> |
| 257 | <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li> |
| 258 | </ul> |
| 259 | </li> |
| 260 | </ul> |
| 261 | <ul> |
| 262 | <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul> |
| 263 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li> |
| 264 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li> |
| 265 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li> |
| 266 | <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li> |
| 267 | </ul> |
| 268 | </li> |
| 269 | </ul> |
| 270 | <ul> |
| 271 | <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul> |
| 272 | <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li> |
| 273 | <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li> |
| 274 | </ul> |
| 275 | </li> |
| 276 | </ul> |
| 277 | <ul> |
| 278 | <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul> |
| 279 | <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li> |
| 280 | <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li> |
| 281 | <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li> |
| 282 | <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li> |
| 283 | <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li> |
| 284 | <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li> |
| 285 | <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li> |
| 286 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li> |
| 287 | <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li> |
| 288 | <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li> |
| 289 | <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li> |
| 290 | <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li> |
| 291 | <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li> |
| 292 | <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li> |
| 293 | <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li> |
| 294 | <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li> |
| 295 | <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li> |
| 296 | <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li> |
| 297 | <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li> |
| 298 | <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li> |
| 299 | <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li> |
| 300 | <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li> |
| 301 | <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li> |
| 302 | <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li> |
| 303 | <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li> |
| 304 | <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li> |
| 305 | </ul> |
| 306 | </li> |
| 307 | </ul> |
| 308 | <ul class="current"> |
| 309 | <li class="toctree-l1 current"><a class="reference internal" href="index.html">Libraries</a><ul class="current"> |
| 310 | <li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking Class</a></li> |
| 311 | <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching Driver</a></li> |
| 312 | <li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendaring Class</a></li> |
| 313 | <li class="toctree-l2"><a class="reference internal" href="cart.html">Shopping Cart Class</a></li> |
| 314 | <li class="toctree-l2"><a class="reference internal" href="config.html">Config Class</a></li> |
| 315 | <li class="toctree-l2"><a class="reference internal" href="email.html">Email Class</a></li> |
| 316 | <li class="toctree-l2"><a class="reference internal" href="encrypt.html">Encrypt Class</a></li> |
| 317 | <li class="toctree-l2"><a class="reference internal" href="encryption.html">Encryption Library</a></li> |
| 318 | <li class="toctree-l2"><a class="reference internal" href="file_uploading.html">File Uploading Class</a></li> |
| 319 | <li class="toctree-l2"><a class="reference internal" href="form_validation.html">Form Validation</a></li> |
| 320 | <li class="toctree-l2"><a class="reference internal" href="ftp.html">FTP Class</a></li> |
| 321 | <li class="toctree-l2"><a class="reference internal" href="image_lib.html">Image Manipulation Class</a></li> |
| 322 | <li class="toctree-l2"><a class="reference internal" href="input.html">Input Class</a></li> |
| 323 | <li class="toctree-l2"><a class="reference internal" href="javascript.html">Javascript Class</a></li> |
| 324 | <li class="toctree-l2"><a class="reference internal" href="language.html">Language Class</a></li> |
| 325 | <li class="toctree-l2"><a class="reference internal" href="loader.html">Loader Class</a></li> |
| 326 | <li class="toctree-l2"><a class="reference internal" href="migration.html">Migrations Class</a></li> |
| 327 | <li class="toctree-l2"><a class="reference internal" href="output.html">Output Class</a></li> |
| 328 | <li class="toctree-l2"><a class="reference internal" href="pagination.html">Pagination Class</a></li> |
| 329 | <li class="toctree-l2"><a class="reference internal" href="parser.html">Template Parser Class</a></li> |
| 330 | <li class="toctree-l2"><a class="reference internal" href="security.html">Security Class</a></li> |
| 331 | <li class="toctree-l2"><a class="reference internal" href="sessions.html">Session Library</a></li> |
| 332 | <li class="toctree-l2"><a class="reference internal" href="table.html">HTML Table Class</a></li> |
| 333 | <li class="toctree-l2 current"><a class="current reference internal" href="#">Trackback Class</a></li> |
| 334 | <li class="toctree-l2"><a class="reference internal" href="typography.html">Typography Class</a></li> |
| 335 | <li class="toctree-l2"><a class="reference internal" href="unit_testing.html">Unit Testing Class</a></li> |
| 336 | <li class="toctree-l2"><a class="reference internal" href="uri.html">URI Class</a></li> |
| 337 | <li class="toctree-l2"><a class="reference internal" href="user_agent.html">User Agent Class</a></li> |
| 338 | <li class="toctree-l2"><a class="reference internal" href="xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li> |
| 339 | <li class="toctree-l2"><a class="reference internal" href="zip.html">Zip Encoding Class</a></li> |
| 340 | </ul> |
| 341 | </li> |
| 342 | </ul> |
| 343 | <ul> |
| 344 | <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul> |
| 345 | <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li> |
| 346 | <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li> |
| 347 | <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li> |
| 348 | <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li> |
| 349 | <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li> |
| 350 | <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li> |
| 351 | <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li> |
| 352 | <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li> |
| 353 | <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li> |
| 354 | <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li> |
| 355 | <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li> |
| 356 | <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li> |
| 357 | <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li> |
| 358 | <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li> |
| 359 | </ul> |
| 360 | </li> |
| 361 | </ul> |
| 362 | <ul> |
| 363 | <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul> |
| 364 | <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li> |
| 365 | <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li> |
| 366 | <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li> |
| 367 | <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li> |
| 368 | <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li> |
| 369 | <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li> |
| 370 | <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li> |
| 371 | <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li> |
| 372 | <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li> |
| 373 | <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li> |
| 374 | <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li> |
| 375 | <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li> |
| 376 | <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li> |
| 377 | <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li> |
| 378 | <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li> |
| 379 | <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li> |
| 380 | <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li> |
| 381 | <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li> |
| 382 | <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li> |
| 383 | <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li> |
| 384 | <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li> |
| 385 | </ul> |
| 386 | </li> |
| 387 | </ul> |
| 388 | |
| 389 | |
| 390 | |
| 391 | </div> |
| 392 | |
| 393 | </nav> |
| 394 | |
| 395 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 396 | |
| 397 | |
| 398 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| 399 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 400 | <a href="../index.html">CodeIgniter</a> |
| 401 | </nav> |
| 402 | |
| 403 | |
| 404 | |
| 405 | <div class="wy-nav-content"> |
| 406 | <div class="rst-content"> |
| 407 | <div role="navigation" aria-label="breadcrumbs navigation"> |
| 408 | <ul class="wy-breadcrumbs"> |
| 409 | <li><a href="../index.html">Docs</a> »</li> |
| 410 | |
| 411 | <li><a href="index.html">Libraries</a> »</li> |
| 412 | |
| 413 | <li>Trackback Class</li> |
| 414 | <li class="wy-breadcrumbs-aside"> |
| 415 | |
| 416 | </li> |
| 417 | <div style="float:right;margin-left:5px;" id="closeMe"> |
| 418 | <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" /> |
| 419 | </div> |
| 420 | </ul> |
| 421 | <hr/> |
| 422 | </div> |
| 423 | <div role="main" class="document"> |
| 424 | |
| 425 | <div class="section" id="trackback-class"> |
| 426 | <h1>Trackback Class<a class="headerlink" href="#trackback-class" title="Permalink to this headline">¶</a></h1> |
| 427 | <p>The Trackback Class provides functions that enable you to send and |
| 428 | receive Trackback data.</p> |
| 429 | <p>If you are not familiar with Trackbacks you’ll find more information |
| 430 | <a class="reference external" href="http://en.wikipedia.org/wiki/Trackback">here</a>.</p> |
| 431 | <div class="contents local topic" id="contents"> |
| 432 | <ul class="simple"> |
| 433 | <li><a class="reference internal" href="#using-the-trackback-class" id="id1">Using the Trackback Class</a><ul> |
| 434 | <li><a class="reference internal" href="#initializing-the-class" id="id2">Initializing the Class</a></li> |
| 435 | <li><a class="reference internal" href="#sending-trackbacks" id="id3">Sending Trackbacks</a></li> |
| 436 | <li><a class="reference internal" href="#receiving-trackbacks" id="id4">Receiving Trackbacks</a></li> |
| 437 | <li><a class="reference internal" href="#your-ping-url" id="id5">Your Ping URL</a></li> |
| 438 | <li><a class="reference internal" href="#creating-a-trackback-table" id="id6">Creating a Trackback Table</a></li> |
| 439 | <li><a class="reference internal" href="#processing-a-trackback" id="id7">Processing a Trackback</a><ul> |
| 440 | <li><a class="reference internal" href="#notes" id="id8">Notes:</a></li> |
| 441 | </ul> |
| 442 | </li> |
| 443 | </ul> |
| 444 | </li> |
| 445 | <li><a class="reference internal" href="#class-reference" id="id9">Class Reference</a></li> |
| 446 | </ul> |
| 447 | </div> |
| 448 | <div class="custom-index container"></div><div class="section" id="using-the-trackback-class"> |
| 449 | <h2><a class="toc-backref" href="#id1">Using the Trackback Class</a><a class="headerlink" href="#using-the-trackback-class" title="Permalink to this headline">¶</a></h2> |
| 450 | <div class="section" id="initializing-the-class"> |
| 451 | <h3><a class="toc-backref" href="#id2">Initializing the Class</a><a class="headerlink" href="#initializing-the-class" title="Permalink to this headline">¶</a></h3> |
| 452 | <p>Like most other classes in CodeIgniter, the Trackback class is |
| 453 | initialized in your controller using the <code class="docutils literal"><span class="pre">$this->load->library()</span></code> method:</p> |
| 454 | <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">'trackback'</span><span class="p">);</span> |
| 455 | </pre></div> |
| 456 | </div> |
| 457 | <p>Once loaded, the Trackback library object will be available using:</p> |
| 458 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span> |
| 459 | </pre></div> |
| 460 | </div> |
| 461 | </div> |
| 462 | <div class="section" id="sending-trackbacks"> |
| 463 | <h3><a class="toc-backref" href="#id3">Sending Trackbacks</a><a class="headerlink" href="#sending-trackbacks" title="Permalink to this headline">¶</a></h3> |
| 464 | <p>A Trackback can be sent from any of your controller functions using code |
| 465 | similar to this example:</p> |
| 466 | <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">'trackback'</span><span class="p">);</span> |
| 467 | |
| 468 | <span class="nv">$tb_data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> |
| 469 | <span class="s1">'ping_url'</span> <span class="o">=></span> <span class="s1">'http://example.com/trackback/456'</span><span class="p">,</span> |
| 470 | <span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://www.my-example.com/blog/entry/123'</span><span class="p">,</span> |
| 471 | <span class="s1">'title'</span> <span class="o">=></span> <span class="s1">'The Title of My Entry'</span><span class="p">,</span> |
| 472 | <span class="s1">'excerpt'</span> <span class="o">=></span> <span class="s1">'The entry content.'</span><span class="p">,</span> |
| 473 | <span class="s1">'blog_name'</span> <span class="o">=></span> <span class="s1">'My Blog Name'</span><span class="p">,</span> |
| 474 | <span class="s1">'charset'</span> <span class="o">=></span> <span class="s1">'utf-8'</span> |
| 475 | <span class="p">);</span> |
| 476 | |
| 477 | <span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">send</span><span class="p">(</span><span class="nv">$tb_data</span><span class="p">))</span> |
| 478 | <span class="p">{</span> |
| 479 | <span class="k">echo</span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">display_errors</span><span class="p">();</span> |
| 480 | <span class="p">}</span> |
| 481 | <span class="k">else</span> |
| 482 | <span class="p">{</span> |
| 483 | <span class="k">echo</span> <span class="s1">'Trackback was sent!'</span><span class="p">;</span> |
| 484 | <span class="p">}</span> |
| 485 | </pre></div> |
| 486 | </div> |
| 487 | <p>Description of array data:</p> |
| 488 | <ul class="simple"> |
| 489 | <li><strong>ping_url</strong> - The URL of the site you are sending the Trackback to. |
| 490 | You can send Trackbacks to multiple URLs by separating each URL with a comma.</li> |
| 491 | <li><strong>url</strong> - The URL to YOUR site where the weblog entry can be seen.</li> |
| 492 | <li><strong>title</strong> - The title of your weblog entry.</li> |
| 493 | <li><strong>excerpt</strong> - The content of your weblog entry.</li> |
| 494 | <li><strong>blog_name</strong> - The name of your weblog.</li> |
| 495 | <li><strong>charset</strong> - The character encoding your weblog is written in. If omitted, UTF-8 will be used.</li> |
| 496 | </ul> |
| 497 | <div class="admonition note"> |
| 498 | <p class="first admonition-title">Note</p> |
| 499 | <p class="last">The Trackback class will automatically send only the first 500 characters of your |
| 500 | entry. It will also strip all HTML.</p> |
| 501 | </div> |
| 502 | <p>The Trackback sending method returns TRUE/FALSE (boolean) on success |
| 503 | or failure. If it fails, you can retrieve the error message using:</p> |
| 504 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">display_errors</span><span class="p">();</span> |
| 505 | </pre></div> |
| 506 | </div> |
| 507 | </div> |
| 508 | <div class="section" id="receiving-trackbacks"> |
| 509 | <h3><a class="toc-backref" href="#id4">Receiving Trackbacks</a><a class="headerlink" href="#receiving-trackbacks" title="Permalink to this headline">¶</a></h3> |
| 510 | <p>Before you can receive Trackbacks you must create a weblog. If you don’t |
| 511 | have a blog yet there’s no point in continuing.</p> |
| 512 | <p>Receiving Trackbacks is a little more complex than sending them, only |
| 513 | because you will need a database table in which to store them, and you |
| 514 | will need to validate the incoming trackback data. You are encouraged to |
| 515 | implement a thorough validation process to guard against spam and |
| 516 | duplicate data. You may also want to limit the number of Trackbacks you |
| 517 | allow from a particular IP within a given span of time to further |
| 518 | curtail spam. The process of receiving a Trackback is quite simple; the |
| 519 | validation is what takes most of the effort.</p> |
| 520 | </div> |
| 521 | <div class="section" id="your-ping-url"> |
| 522 | <h3><a class="toc-backref" href="#id5">Your Ping URL</a><a class="headerlink" href="#your-ping-url" title="Permalink to this headline">¶</a></h3> |
| 523 | <p>In order to accept Trackbacks you must display a Trackback URL next to |
| 524 | each one of your weblog entries. This will be the URL that people will |
| 525 | use to send you Trackbacks (we will refer to this as your “Ping URL”).</p> |
| 526 | <p>Your Ping URL must point to a controller function where your Trackback |
| 527 | receiving code is located, and the URL must contain the ID number for |
| 528 | each particular entry, so that when the Trackback is received you’ll be |
| 529 | able to associate it with a particular entry.</p> |
| 530 | <p>For example, if your controller class is called Trackback, and the |
| 531 | receiving function is called receive, your Ping URLs will look something |
| 532 | like this:</p> |
| 533 | <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">trackback</span><span class="o">/</span><span class="nx">receive</span><span class="o">/</span><span class="nx">entry_id</span> |
| 534 | </pre></div> |
| 535 | </div> |
| 536 | <p>Where entry_id represents the individual ID number for each of your |
| 537 | entries.</p> |
| 538 | </div> |
| 539 | <div class="section" id="creating-a-trackback-table"> |
| 540 | <h3><a class="toc-backref" href="#id6">Creating a Trackback Table</a><a class="headerlink" href="#creating-a-trackback-table" title="Permalink to this headline">¶</a></h3> |
| 541 | <p>Before you can receive Trackbacks you must create a table in which to |
| 542 | store them. Here is a basic prototype for such a table:</p> |
| 543 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">CREATE</span> <span class="nx">TABLE</span> <span class="nx">trackbacks</span> <span class="p">(</span> |
| 544 | <span class="nx">tb_id</span> <span class="nx">int</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="nx">unsigned</span> <span class="k">NOT</span> <span class="k">NULL</span> <span class="nx">auto_increment</span><span class="p">,</span> |
| 545 | <span class="nx">entry_id</span> <span class="nx">int</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="nx">unsigned</span> <span class="k">NOT</span> <span class="k">NULL</span> <span class="k">default</span> <span class="mi">0</span><span class="p">,</span> |
| 546 | <span class="nx">url</span> <span class="nx">varchar</span><span class="p">(</span><span class="mi">200</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 547 | <span class="nx">title</span> <span class="nx">varchar</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 548 | <span class="nx">excerpt</span> <span class="nx">text</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 549 | <span class="nx">blog_name</span> <span class="nx">varchar</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 550 | <span class="nx">tb_date</span> <span class="nx">int</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 551 | <span class="nx">ip_address</span> <span class="nx">varchar</span><span class="p">(</span><span class="mi">45</span><span class="p">)</span> <span class="k">NOT</span> <span class="k">NULL</span><span class="p">,</span> |
| 552 | <span class="nx">PRIMARY</span> <span class="nx">KEY</span> <span class="sb">`tb_id`</span> <span class="p">(</span><span class="sb">`tb_id`</span><span class="p">),</span> |
| 553 | <span class="nx">KEY</span> <span class="sb">`entry_id`</span> <span class="p">(</span><span class="sb">`entry_id`</span><span class="p">)</span> |
| 554 | <span class="p">);</span> |
| 555 | </pre></div> |
| 556 | </div> |
| 557 | <p>The Trackback specification only requires four pieces of information to |
| 558 | be sent in a Trackback (url, title, excerpt, blog_name), but to make |
| 559 | the data more useful we’ve added a few more fields in the above table |
| 560 | schema (date, IP address, etc.).</p> |
| 561 | </div> |
| 562 | <div class="section" id="processing-a-trackback"> |
| 563 | <h3><a class="toc-backref" href="#id7">Processing a Trackback</a><a class="headerlink" href="#processing-a-trackback" title="Permalink to this headline">¶</a></h3> |
| 564 | <p>Here is an example showing how you will receive and process a Trackback. |
| 565 | The following code is intended for use within the controller function |
| 566 | where you expect to receive Trackbacks.:</p> |
| 567 | <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">'trackback'</span><span class="p">);</span> |
| 568 | <span class="nv">$this</span><span class="o">-></span><span class="na">load</span><span class="o">-></span><span class="na">database</span><span class="p">();</span> |
| 569 | |
| 570 | <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">uri</span><span class="o">-></span><span class="na">segment</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="o">==</span> <span class="k">FALSE</span><span class="p">)</span> |
| 571 | <span class="p">{</span> |
| 572 | <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">send_error</span><span class="p">(</span><span class="s1">'Unable to determine the entry ID'</span><span class="p">);</span> |
| 573 | <span class="p">}</span> |
| 574 | |
| 575 | <span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">receive</span><span class="p">())</span> |
| 576 | <span class="p">{</span> |
| 577 | <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">send_error</span><span class="p">(</span><span class="s1">'The Trackback did not contain valid data'</span><span class="p">);</span> |
| 578 | <span class="p">}</span> |
| 579 | |
| 580 | <span class="nv">$data</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span> |
| 581 | <span class="s1">'tb_id'</span> <span class="o">=></span> <span class="s1">''</span><span class="p">,</span> |
| 582 | <span class="s1">'entry_id'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">uri</span><span class="o">-></span><span class="na">segment</span><span class="p">(</span><span class="mi">3</span><span class="p">),</span> |
| 583 | <span class="s1">'url'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'url'</span><span class="p">),</span> |
| 584 | <span class="s1">'title'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'title'</span><span class="p">),</span> |
| 585 | <span class="s1">'excerpt'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'excerpt'</span><span class="p">),</span> |
| 586 | <span class="s1">'blog_name'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'blog_name'</span><span class="p">),</span> |
| 587 | <span class="s1">'tb_date'</span> <span class="o">=></span> <span class="nb">time</span><span class="p">(),</span> |
| 588 | <span class="s1">'ip_address'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">input</span><span class="o">-></span><span class="na">ip_address</span><span class="p">()</span> |
| 589 | <span class="p">);</span> |
| 590 | |
| 591 | <span class="nv">$sql</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">db</span><span class="o">-></span><span class="na">insert_string</span><span class="p">(</span><span class="s1">'trackbacks'</span><span class="p">,</span> <span class="nv">$data</span><span class="p">);</span> |
| 592 | <span class="nv">$this</span><span class="o">-></span><span class="na">db</span><span class="o">-></span><span class="na">query</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span> |
| 593 | |
| 594 | <span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">send_success</span><span class="p">();</span> |
| 595 | </pre></div> |
| 596 | </div> |
| 597 | <div class="section" id="notes"> |
| 598 | <h4><a class="toc-backref" href="#id8">Notes:</a><a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h4> |
| 599 | <p>The entry ID number is expected in the third segment of your URL. This |
| 600 | is based on the URI example we gave earlier:</p> |
| 601 | <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">trackback</span><span class="o">/</span><span class="nx">receive</span><span class="o">/</span><span class="nx">entry_id</span> |
| 602 | </pre></div> |
| 603 | </div> |
| 604 | <p>Notice the entry_id is in the third URI segment, which you can retrieve |
| 605 | using:</p> |
| 606 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">uri</span><span class="o">-></span><span class="na">segment</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span> |
| 607 | </pre></div> |
| 608 | </div> |
| 609 | <p>In our Trackback receiving code above, if the third segment is missing, |
| 610 | we will issue an error. Without a valid entry ID, there’s no reason to |
| 611 | continue.</p> |
| 612 | <p>The $this->trackback->receive() function is simply a validation function |
| 613 | that looks at the incoming data and makes sure it contains the four |
| 614 | pieces of data that are required (url, title, excerpt, blog_name). It |
| 615 | returns TRUE on success and FALSE on failure. If it fails you will issue |
| 616 | an error message.</p> |
| 617 | <p>The incoming Trackback data can be retrieved using this function:</p> |
| 618 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">data</span><span class="p">(</span><span class="s1">'item'</span><span class="p">)</span> |
| 619 | </pre></div> |
| 620 | </div> |
| 621 | <p>Where item represents one of these four pieces of info: url, title, |
| 622 | excerpt, or blog_name</p> |
| 623 | <p>If the Trackback data is successfully received, you will issue a success |
| 624 | message using:</p> |
| 625 | <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">trackback</span><span class="o">-></span><span class="na">send_success</span><span class="p">();</span> |
| 626 | </pre></div> |
| 627 | </div> |
| 628 | <div class="admonition note"> |
| 629 | <p class="first admonition-title">Note</p> |
| 630 | <p class="last">The above code contains no data validation, which you are |
| 631 | encouraged to add.</p> |
| 632 | </div> |
| 633 | </div> |
| 634 | </div> |
| 635 | </div> |
| 636 | <div class="section" id="class-reference"> |
| 637 | <h2><a class="toc-backref" href="#id9">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline">¶</a></h2> |
| 638 | <dl class="class"> |
| 639 | <dt id="CI_Trackback"> |
| 640 | <em class="property">class </em><code class="descname">CI_Trackback</code><a class="headerlink" href="#CI_Trackback" title="Permalink to this definition">¶</a></dt> |
| 641 | <dd><dl class="attribute"> |
| 642 | <dt> |
| 643 | <code class="descname">$data = array('url' => '', 'title' => '', 'excerpt' => '', 'blog_name' => '', 'charset' => '')</code></dt> |
| 644 | <dd><p>Trackback data array.</p> |
| 645 | </dd></dl> |
| 646 | |
| 647 | <dl class="attribute"> |
| 648 | <dt> |
| 649 | <code class="descname">$convert_ascii = TRUE</code></dt> |
| 650 | <dd><p>Whether to convert high ASCII and MS Word characters to HTML entities.</p> |
| 651 | </dd></dl> |
| 652 | |
| 653 | <dl class="method"> |
| 654 | <dt id="CI_Trackback::send"> |
| 655 | <code class="descname">send</code><span class="sig-paren">(</span><em>$tb_data</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::send" title="Permalink to this definition">¶</a></dt> |
| 656 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 657 | <col class="field-name" /> |
| 658 | <col class="field-body" /> |
| 659 | <tbody valign="top"> |
| 660 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 661 | <li><strong>$tb_data</strong> (<em>array</em>) – Trackback data</li> |
| 662 | </ul> |
| 663 | </td> |
| 664 | </tr> |
| 665 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p> |
| 666 | </td> |
| 667 | </tr> |
| 668 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p> |
| 669 | </td> |
| 670 | </tr> |
| 671 | </tbody> |
| 672 | </table> |
| 673 | <p>Send trackback.</p> |
| 674 | </dd></dl> |
| 675 | |
| 676 | <dl class="method"> |
| 677 | <dt id="CI_Trackback::receive"> |
| 678 | <code class="descname">receive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::receive" title="Permalink to this definition">¶</a></dt> |
| 679 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 680 | <col class="field-name" /> |
| 681 | <col class="field-body" /> |
| 682 | <tbody valign="top"> |
| 683 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">TRUE on success, FALSE on failure</td> |
| 684 | </tr> |
| 685 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td> |
| 686 | </tr> |
| 687 | </tbody> |
| 688 | </table> |
| 689 | <p>This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure. |
| 690 | If the data is valid it is set to the <code class="docutils literal"><span class="pre">$this->data</span></code> array so that it can be inserted into a database.</p> |
| 691 | </dd></dl> |
| 692 | |
| 693 | <dl class="method"> |
| 694 | <dt id="CI_Trackback::send_error"> |
| 695 | <code class="descname">send_error</code><span class="sig-paren">(</span><span class="optional">[</span><em>$message = 'Incomplete information'</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::send_error" title="Permalink to this definition">¶</a></dt> |
| 696 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 697 | <col class="field-name" /> |
| 698 | <col class="field-body" /> |
| 699 | <tbody valign="top"> |
| 700 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 701 | <li><strong>$message</strong> (<em>string</em>) – Error message</li> |
| 702 | </ul> |
| 703 | </td> |
| 704 | </tr> |
| 705 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p> |
| 706 | </td> |
| 707 | </tr> |
| 708 | </tbody> |
| 709 | </table> |
| 710 | <p>Responses to a trackback request with an error message.</p> |
| 711 | <div class="admonition note"> |
| 712 | <p class="first admonition-title">Note</p> |
| 713 | <p class="last">This method will terminate script execution.</p> |
| 714 | </div> |
| 715 | </dd></dl> |
| 716 | |
| 717 | <dl class="method"> |
| 718 | <dt id="CI_Trackback::send_success"> |
| 719 | <code class="descname">send_success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::send_success" title="Permalink to this definition">¶</a></dt> |
| 720 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 721 | <col class="field-name" /> |
| 722 | <col class="field-body" /> |
| 723 | <tbody valign="top"> |
| 724 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td> |
| 725 | </tr> |
| 726 | </tbody> |
| 727 | </table> |
| 728 | <p>Responses to a trackback request with a success message.</p> |
| 729 | <div class="admonition note"> |
| 730 | <p class="first admonition-title">Note</p> |
| 731 | <p class="last">This method will terminate script execution.</p> |
| 732 | </div> |
| 733 | </dd></dl> |
| 734 | |
| 735 | <dl class="method"> |
| 736 | <dt id="CI_Trackback::data"> |
| 737 | <code class="descname">data</code><span class="sig-paren">(</span><em>$item</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::data" title="Permalink to this definition">¶</a></dt> |
| 738 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 739 | <col class="field-name" /> |
| 740 | <col class="field-body" /> |
| 741 | <tbody valign="top"> |
| 742 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 743 | <li><strong>$item</strong> (<em>string</em>) – Data key</li> |
| 744 | </ul> |
| 745 | </td> |
| 746 | </tr> |
| 747 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data value or empty string if not found</p> |
| 748 | </td> |
| 749 | </tr> |
| 750 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 751 | </td> |
| 752 | </tr> |
| 753 | </tbody> |
| 754 | </table> |
| 755 | <p>Returns a single item from the response data array.</p> |
| 756 | </dd></dl> |
| 757 | |
| 758 | <dl class="method"> |
| 759 | <dt id="CI_Trackback::process"> |
| 760 | <code class="descname">process</code><span class="sig-paren">(</span><em>$url</em>, <em>$data</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::process" title="Permalink to this definition">¶</a></dt> |
| 761 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 762 | <col class="field-name" /> |
| 763 | <col class="field-body" /> |
| 764 | <tbody valign="top"> |
| 765 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 766 | <li><strong>$url</strong> (<em>string</em>) – Target url</li> |
| 767 | <li><strong>$data</strong> (<em>string</em>) – Raw POST data</li> |
| 768 | </ul> |
| 769 | </td> |
| 770 | </tr> |
| 771 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">TRUE on success, FALSE on failure</p> |
| 772 | </td> |
| 773 | </tr> |
| 774 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p> |
| 775 | </td> |
| 776 | </tr> |
| 777 | </tbody> |
| 778 | </table> |
| 779 | <p>Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure.</p> |
| 780 | </dd></dl> |
| 781 | |
| 782 | <dl class="method"> |
| 783 | <dt id="CI_Trackback::extract_urls"> |
| 784 | <code class="descname">extract_urls</code><span class="sig-paren">(</span><em>$urls</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::extract_urls" title="Permalink to this definition">¶</a></dt> |
| 785 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 786 | <col class="field-name" /> |
| 787 | <col class="field-body" /> |
| 788 | <tbody valign="top"> |
| 789 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 790 | <li><strong>$urls</strong> (<em>string</em>) – Comma-separated URL list</li> |
| 791 | </ul> |
| 792 | </td> |
| 793 | </tr> |
| 794 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Array of URLs</p> |
| 795 | </td> |
| 796 | </tr> |
| 797 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">array</p> |
| 798 | </td> |
| 799 | </tr> |
| 800 | </tbody> |
| 801 | </table> |
| 802 | <p>This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array.</p> |
| 803 | </dd></dl> |
| 804 | |
| 805 | <dl class="method"> |
| 806 | <dt id="CI_Trackback::validate_url"> |
| 807 | <code class="descname">validate_url</code><span class="sig-paren">(</span><em>&$url</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::validate_url" title="Permalink to this definition">¶</a></dt> |
| 808 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 809 | <col class="field-name" /> |
| 810 | <col class="field-body" /> |
| 811 | <tbody valign="top"> |
| 812 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 813 | <li><strong>$url</strong> (<em>string</em>) – Trackback URL</li> |
| 814 | </ul> |
| 815 | </td> |
| 816 | </tr> |
| 817 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p> |
| 818 | </td> |
| 819 | </tr> |
| 820 | </tbody> |
| 821 | </table> |
| 822 | <p>Simply adds the <em>http://</em> prefix it it’s not already present in the URL.</p> |
| 823 | </dd></dl> |
| 824 | |
| 825 | <dl class="method"> |
| 826 | <dt id="CI_Trackback::get_id"> |
| 827 | <code class="descname">get_id</code><span class="sig-paren">(</span><em>$url</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::get_id" title="Permalink to this definition">¶</a></dt> |
| 828 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 829 | <col class="field-name" /> |
| 830 | <col class="field-body" /> |
| 831 | <tbody valign="top"> |
| 832 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 833 | <li><strong>$url</strong> (<em>string</em>) – Trackback URL</li> |
| 834 | </ul> |
| 835 | </td> |
| 836 | </tr> |
| 837 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">URL ID or FALSE on failure</p> |
| 838 | </td> |
| 839 | </tr> |
| 840 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 841 | </td> |
| 842 | </tr> |
| 843 | </tbody> |
| 844 | </table> |
| 845 | <p>Find and return a trackback URL’s ID or FALSE on failure.</p> |
| 846 | </dd></dl> |
| 847 | |
| 848 | <dl class="method"> |
| 849 | <dt id="CI_Trackback::convert_xml"> |
| 850 | <code class="descname">convert_xml</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::convert_xml" title="Permalink to this definition">¶</a></dt> |
| 851 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 852 | <col class="field-name" /> |
| 853 | <col class="field-body" /> |
| 854 | <tbody valign="top"> |
| 855 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 856 | <li><strong>$str</strong> (<em>string</em>) – Input string</li> |
| 857 | </ul> |
| 858 | </td> |
| 859 | </tr> |
| 860 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Converted string</p> |
| 861 | </td> |
| 862 | </tr> |
| 863 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 864 | </td> |
| 865 | </tr> |
| 866 | </tbody> |
| 867 | </table> |
| 868 | <p>Converts reserved XML characters to entities.</p> |
| 869 | </dd></dl> |
| 870 | |
| 871 | <dl class="method"> |
| 872 | <dt id="CI_Trackback::limit_characters"> |
| 873 | <code class="descname">limit_characters</code><span class="sig-paren">(</span><em>$str</em><span class="optional">[</span>, <em>$n = 500</em><span class="optional">[</span>, <em>$end_char = '&#8230;'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::limit_characters" title="Permalink to this definition">¶</a></dt> |
| 874 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 875 | <col class="field-name" /> |
| 876 | <col class="field-body" /> |
| 877 | <tbody valign="top"> |
| 878 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 879 | <li><strong>$str</strong> (<em>string</em>) – Input string</li> |
| 880 | <li><strong>$n</strong> (<em>int</em>) – Max characters number</li> |
| 881 | <li><strong>$end_char</strong> (<em>string</em>) – Character to put at end of string</li> |
| 882 | </ul> |
| 883 | </td> |
| 884 | </tr> |
| 885 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Shortened string</p> |
| 886 | </td> |
| 887 | </tr> |
| 888 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 889 | </td> |
| 890 | </tr> |
| 891 | </tbody> |
| 892 | </table> |
| 893 | <p>Limits the string based on the character count. Will preserve complete words.</p> |
| 894 | </dd></dl> |
| 895 | |
| 896 | <dl class="method"> |
| 897 | <dt id="CI_Trackback::convert_ascii"> |
| 898 | <code class="descname">convert_ascii</code><span class="sig-paren">(</span><em>$str</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::convert_ascii" title="Permalink to this definition">¶</a></dt> |
| 899 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 900 | <col class="field-name" /> |
| 901 | <col class="field-body" /> |
| 902 | <tbody valign="top"> |
| 903 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 904 | <li><strong>$str</strong> (<em>string</em>) – Input string</li> |
| 905 | </ul> |
| 906 | </td> |
| 907 | </tr> |
| 908 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Converted string</p> |
| 909 | </td> |
| 910 | </tr> |
| 911 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 912 | </td> |
| 913 | </tr> |
| 914 | </tbody> |
| 915 | </table> |
| 916 | <p>Converts high ASCII text and MS Word special characterss to HTML entities.</p> |
| 917 | </dd></dl> |
| 918 | |
| 919 | <dl class="method"> |
| 920 | <dt id="CI_Trackback::set_error"> |
| 921 | <code class="descname">set_error</code><span class="sig-paren">(</span><em>$msg</em><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::set_error" title="Permalink to this definition">¶</a></dt> |
| 922 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 923 | <col class="field-name" /> |
| 924 | <col class="field-body" /> |
| 925 | <tbody valign="top"> |
| 926 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 927 | <li><strong>$msg</strong> (<em>string</em>) – Error message</li> |
| 928 | </ul> |
| 929 | </td> |
| 930 | </tr> |
| 931 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p> |
| 932 | </td> |
| 933 | </tr> |
| 934 | </tbody> |
| 935 | </table> |
| 936 | <p>Set an log an error message.</p> |
| 937 | </dd></dl> |
| 938 | |
| 939 | <dl class="method"> |
| 940 | <dt id="CI_Trackback::display_errors"> |
| 941 | <code class="descname">display_errors</code><span class="sig-paren">(</span><span class="optional">[</span><em>$open = '<p>'</em><span class="optional">[</span>, <em>$close = '</p>'</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CI_Trackback::display_errors" title="Permalink to this definition">¶</a></dt> |
| 942 | <dd><table class="docutils field-list" frame="void" rules="none"> |
| 943 | <col class="field-name" /> |
| 944 | <col class="field-body" /> |
| 945 | <tbody valign="top"> |
| 946 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 947 | <li><strong>$open</strong> (<em>string</em>) – Open tag</li> |
| 948 | <li><strong>$close</strong> (<em>string</em>) – Close tag</li> |
| 949 | </ul> |
| 950 | </td> |
| 951 | </tr> |
| 952 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML formatted error messages</p> |
| 953 | </td> |
| 954 | </tr> |
| 955 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p> |
| 956 | </td> |
| 957 | </tr> |
| 958 | </tbody> |
| 959 | </table> |
| 960 | <p>Returns error messages formatted in HTML or an empty string if there are no errors.</p> |
| 961 | </dd></dl> |
| 962 | |
| 963 | </dd></dl> |
| 964 | |
| 965 | </div> |
| 966 | </div> |
| 967 | |
| 968 | |
| 969 | </div> |
| 970 | <footer> |
| 971 | |
| 972 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 973 | |
| 974 | <a href="typography.html" class="btn btn-neutral float-right" title="Typography Class">Next <span class="fa fa-arrow-circle-right"></span></a> |
| 975 | |
| 976 | |
| 977 | <a href="table.html" class="btn btn-neutral" title="HTML Table Class"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| 978 | |
| 979 | </div> |
| 980 | |
| 981 | |
| 982 | <hr/> |
| 983 | |
| 984 | <div role="contentinfo"> |
| 985 | <p> |
| 986 | © Copyright 2014 - 2019, British Columbia Institute of Technology. |
| 987 | Last updated on Jan 16, 2019. |
| 988 | </p> |
| 989 | </div> |
| 990 | |
| 991 | 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>. |
| 992 | |
| 993 | </footer> |
| 994 | </div> |
| 995 | </div> |
| 996 | |
| 997 | </section> |
| 998 | |
| 999 | </div> |
| 1000 | |
| 1001 | |
| 1002 | |
| 1003 | |
| 1004 | |
| 1005 | <script type="text/javascript"> |
| 1006 | var DOCUMENTATION_OPTIONS = { |
| 1007 | URL_ROOT:'../', |
| 1008 | VERSION:'3.1.10', |
| 1009 | COLLAPSE_INDEX:false, |
| 1010 | FILE_SUFFIX:'.html', |
| 1011 | HAS_SOURCE: false |
| 1012 | }; |
| 1013 | </script> |
| 1014 | <script type="text/javascript" src="../_static/jquery.js"></script> |
| 1015 | <script type="text/javascript" src="../_static/underscore.js"></script> |
| 1016 | <script type="text/javascript" src="../_static/doctools.js"></script> |
| 1017 | |
| 1018 | |
| 1019 | |
| 1020 | |
| 1021 | |
| 1022 | <script type="text/javascript" src="../_static/js/theme.js"></script> |
| 1023 | |
| 1024 | |
| 1025 | |
| 1026 | |
| 1027 | <script type="text/javascript"> |
| 1028 | jQuery(function () { |
| 1029 | SphinxRtdTheme.StickyNav.enable(); |
| 1030 | }); |
| 1031 | </script> |
| 1032 | |
| 1033 | |
| 1034 | </body> |
| 1035 | </html> |