mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
797 lines
64 KiB
HTML
797 lines
64 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>HTML Table Class — CodeIgniter 4.3.8 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/citheme_dark.css" type="text/css" />
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/js/citheme.js"></script>
|
||
<script src="../_static/js/carbon.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="HTTP Responses" href="response.html" />
|
||
<link rel="prev" title="View Decorators" href="view_decorators.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html">
|
||
|
||
<img src="../_static/ci-logo-text.svg" class="logo" alt="Logo"/>
|
||
</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" aria-label="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="Navigation menu">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/requirements.html">Server Requirements</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/credits.html">Credits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/psr.html">PSR Compliance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../license.html">License Agreement</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_composer.html">Composer Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_manual.html">Manual Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/running.html">Running Your App</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../changelogs/index.html">Change Logs</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/repositories.html">CodeIgniter Repositories</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Build Your First Application</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="../concepts/index.html">CodeIgniter4 Overview</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/structure.html">Application Structure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/mvc.html">Models, Views, and Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/autoloader.html">Autoloading Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/services.html">Services</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/factories.html">Factories</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/http.html">Working with HTTP Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/security.html">Security Guidelines</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/configuration.html">Configuration</a></li>
|
||
<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/helpers.html">Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Global Functions and Constants</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/logging.html">Logging Information</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">Web Page Caching</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/ajax.html">AJAX Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/modules.html">Code Modules</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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../incoming/index.html">Controllers and Routing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/routing.html">URI Routing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/controllers.html">Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/filters.html">Controller Filters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/message.html">HTTP Messages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/request.html">Request Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/incomingrequest.html">IncomingRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/content_negotiation.html">Content Negotiation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/methodspoofing.html">HTTP Method Spoofing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/restful.html">RESTful Resource Handling</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Building Responses</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="view_cells.html">View Cells</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="view_renderer.html">View Renderer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="view_layouts.html">View Layouts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="view_parser.html">View Parser</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="view_decorators.html">View Decorators</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">HTML Table Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="response.html">HTTP Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="api_responses.html">API Response Trait</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="localization.html">Localization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Working with Databases</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/events.html">Database Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../models/index.html">Modeling Data</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/model.html">Using CodeIgniter's Model</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/entities.html">Using Entity Classes</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../dbmgmt/index.html">Managing Databases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/forge.html">Database Manipulation with Database Forge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/migration.html">Database Migrations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/seeds.html">Database Seeding</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/db_commands.html">Database Commands</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Library Reference</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/cookies.html">Cookies</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/curlrequest.html">CURLRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Service</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/files.html">Working with Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_collections.html">File Collections</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/honeypot.html">Honeypot Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/images.html">Image Manipulation Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/publisher.html">Publisher</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/throttler.html">Throttler</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/time.html">Times and Dates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uploaded_files.html">Working with Uploaded Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">Working with URIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/validation.html">Validation</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/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/filesystem_helper.html">Filesystem 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/number_helper.html">Number 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/test_helper.html">Test 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/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>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../testing/index.html">Testing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/overview.html">Getting Started</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/database.html">Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/fabricator.html">Generating Data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/controllers.html">Controller Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/feature.html">HTTP Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/response.html">Testing Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/benchmark.html">Benchmarking</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/debugging.html">Debugging Your Application</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/mocking.html">Mocking</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">Command Line Usage</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_overview.html">CLI Overview</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_controllers.html">Running Controllers via CLI</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/spark_commands.html">Spark Commands</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_commands.html">Creating Spark Commands</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_generators.html">CLI Generators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_library.html">CLI Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_request.html">CLIRequest Class</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../extending/index.html">Extending CodeIgniter</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/core_classes.html">Creating Core System Classes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/common.html">Replacing Common Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/events.html">Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/basecontroller.html">Extending the Controller</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/authentication.html">Authentication</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/composer_packages.html">Creating Composer Packages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/contributing.html">Contributing to CodeIgniter</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../libraries/official_packages.html">Official Packages</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<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">
|
||
<a class="btn btn-neutral float-right" href="https://github.com/codeigniter4/CodeIgniter4/edit/develop/user_guide_src/source/outgoing/table.rst">Edit this page</a>
|
||
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="index.html">Building Responses</a></li>
|
||
<li class="breadcrumb-item active">HTML Table Class</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="html-table-class">
|
||
<h1>HTML Table Class<a class="headerlink" href="#html-table-class" title="Permalink to this headline"></a></h1>
|
||
<p>The Table Class provides methods that enable you to auto-generate HTML
|
||
tables from arrays or database result sets.</p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#using-the-table-class" id="id1">Using the Table Class</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#initializing-the-class" id="id2">Initializing the Class</a></p></li>
|
||
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
|
||
<li><p><a class="reference internal" href="#changing-the-look-of-your-table" id="id4">Changing the Look of Your Table</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#namespace-CodeIgniter\View" id="id5">Class Reference</a></p></li>
|
||
</ul>
|
||
</div>
|
||
<section id="using-the-table-class">
|
||
<h2><a class="toc-backref" href="#id1">Using the Table Class</a><a class="headerlink" href="#using-the-table-class" title="Permalink to this headline"></a></h2>
|
||
<section id="initializing-the-class">
|
||
<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>
|
||
<p>The Table class is not provided as a service, and should be instantiated
|
||
“normally”, for instance:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="examples">
|
||
<h3><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline"></a></h3>
|
||
<p>Here is an example showing how you can create a table from a
|
||
multi-dimensional array. Note that the first array index will become the
|
||
table heading (or you can set your own headings using the <code class="docutils literal notranslate"><span class="pre">setHeading()</span></code>
|
||
method described in the function reference below).</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="p">[</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">],</span>
|
||
<span class="p">[</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Small'</span><span class="p">],</span>
|
||
<span class="p">[</span><span class="s1">'Mary'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Large'</span><span class="p">],</span>
|
||
<span class="p">[</span><span class="s1">'John'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">,</span> <span class="s1">'Medium'</span><span class="p">],</span>
|
||
<span class="p">];</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Here is an example of a table created from a database query result. The
|
||
table class will automatically generate the headings based on the table
|
||
names (or you can set your own headings using the <code class="docutils literal notranslate"><span class="pre">setHeading()</span></code>
|
||
method described in the class reference below).</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$query</span> <span class="o">=</span> <span class="nv">$db</span><span class="o">-></span><span class="na">query</span><span class="p">(</span><span class="s1">'SELECT * FROM my_table'</span><span class="p">);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">(</span><span class="nv">$query</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Here is an example showing how you might create a table using discrete
|
||
parameters:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setHeading</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Small'</span><span class="p">);</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Mary'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Large'</span><span class="p">);</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">,</span> <span class="s1">'Medium'</span><span class="p">);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Here is the same example, except instead of individual parameters,
|
||
arrays are used:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setHeading</span><span class="p">([</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">]);</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">([</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Small'</span><span class="p">]);</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">([</span><span class="s1">'Mary'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Large'</span><span class="p">]);</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">([</span><span class="s1">'John'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">,</span> <span class="s1">'Medium'</span><span class="p">]);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="changing-the-look-of-your-table">
|
||
<h3><a class="toc-backref" href="#id4">Changing the Look of Your Table</a><a class="headerlink" href="#changing-the-look-of-your-table" title="Permalink to this headline"></a></h3>
|
||
<p>The Table Class permits you to set a table template with which you can
|
||
specify the design of your layout. Here is the template prototype:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$template</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="s1">'table_open'</span> <span class="o">=></span> <span class="s1">'<table border="0" cellpadding="4" cellspacing="0">'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'thead_open'</span> <span class="o">=></span> <span class="s1">'<thead>'</span><span class="p">,</span>
|
||
<span class="s1">'thead_close'</span> <span class="o">=></span> <span class="s1">'</thead>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'heading_row_start'</span> <span class="o">=></span> <span class="s1">'<tr>'</span><span class="p">,</span>
|
||
<span class="s1">'heading_row_end'</span> <span class="o">=></span> <span class="s1">'</tr>'</span><span class="p">,</span>
|
||
<span class="s1">'heading_cell_start'</span> <span class="o">=></span> <span class="s1">'<th>'</span><span class="p">,</span>
|
||
<span class="s1">'heading_cell_end'</span> <span class="o">=></span> <span class="s1">'</th>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'tfoot_open'</span> <span class="o">=></span> <span class="s1">'<tfoot>'</span><span class="p">,</span>
|
||
<span class="s1">'tfoot_close'</span> <span class="o">=></span> <span class="s1">'</tfoot>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'footing_row_start'</span> <span class="o">=></span> <span class="s1">'<tr>'</span><span class="p">,</span>
|
||
<span class="s1">'footing_row_end'</span> <span class="o">=></span> <span class="s1">'</tr>'</span><span class="p">,</span>
|
||
<span class="s1">'footing_cell_start'</span> <span class="o">=></span> <span class="s1">'<td>'</span><span class="p">,</span>
|
||
<span class="s1">'footing_cell_end'</span> <span class="o">=></span> <span class="s1">'</td>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'tbody_open'</span> <span class="o">=></span> <span class="s1">'<tbody>'</span><span class="p">,</span>
|
||
<span class="s1">'tbody_close'</span> <span class="o">=></span> <span class="s1">'</tbody>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'row_start'</span> <span class="o">=></span> <span class="s1">'<tr>'</span><span class="p">,</span>
|
||
<span class="s1">'row_end'</span> <span class="o">=></span> <span class="s1">'</tr>'</span><span class="p">,</span>
|
||
<span class="s1">'cell_start'</span> <span class="o">=></span> <span class="s1">'<td>'</span><span class="p">,</span>
|
||
<span class="s1">'cell_end'</span> <span class="o">=></span> <span class="s1">'</td>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'row_alt_start'</span> <span class="o">=></span> <span class="s1">'<tr>'</span><span class="p">,</span>
|
||
<span class="s1">'row_alt_end'</span> <span class="o">=></span> <span class="s1">'</tr>'</span><span class="p">,</span>
|
||
<span class="s1">'cell_alt_start'</span> <span class="o">=></span> <span class="s1">'<td>'</span><span class="p">,</span>
|
||
<span class="s1">'cell_alt_end'</span> <span class="o">=></span> <span class="s1">'</td>'</span><span class="p">,</span>
|
||
|
||
<span class="s1">'table_close'</span> <span class="o">=></span> <span class="s1">'</table>'</span><span class="p">,</span>
|
||
<span class="p">];</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setTemplate</span><span class="p">(</span><span class="nv">$template</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>You’ll notice there are two sets of “row” blocks in the
|
||
template. These permit you to create alternating row colors or design
|
||
elements that alternate with each iteration of the row data.</p>
|
||
</div>
|
||
<p>You are NOT required to submit a complete template. If you only need to
|
||
change parts of the layout you can simply submit those elements. In this
|
||
example, only the table opening tag is being changed:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$template</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="s1">'table_open'</span> <span class="o">=></span> <span class="s1">'<table border="1" cellpadding="2" cellspacing="1" class="mytable">'</span><span class="p">,</span>
|
||
<span class="p">];</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setTemplate</span><span class="p">(</span><span class="nv">$template</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also set defaults for these by passing an array of template settings
|
||
to the Table constructor:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$customSettings</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="s1">'table_open'</span> <span class="o">=></span> <span class="s1">'<table border="1" cellpadding="2" cellspacing="1" class="mytable">'</span><span class="p">,</span>
|
||
<span class="p">];</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">(</span><span class="nv">$customSettings</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="namespace-CodeIgniter\View">
|
||
<span id="class-reference"></span><h2><a class="toc-backref" href="#id5">Class Reference</a><a class="headerlink" href="#namespace-CodeIgniter\View" title="Permalink to this headline"></a></h2>
|
||
<dl class="php class">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">CodeIgniter\View\</span></span><span class="sig-name descname"><span class="pre">Table</span></span><a class="headerlink" href="#CodeIgniter\View\Table" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="py attribute">
|
||
<dt class="sig sig-object py">
|
||
<span class="sig-name descname"><span class="pre">$function</span> <span class="pre">=</span> <span class="pre">null</span></span></dt>
|
||
<dd><p>Allows you to specify a native PHP function or a valid function array object to be applied to all cell data.</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setHeading</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">);</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'<strong>Blue</strong>'</span><span class="p">,</span> <span class="s1">'Small'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">function</span> <span class="o">=</span> <span class="s1">'htmlspecialchars'</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>In the above example, all cell data would be run through PHP’s <code class="xref php php-func docutils literal notranslate"><span class="pre">htmlspecialchars()</span></code> function, resulting in:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">td</span><span class="o">></span><span class="nx">Fred</span><span class="o"></</span><span class="nx">td</span><span class="o">><</span><span class="nx">td</span><span class="o">>&</span><span class="nx">lt</span><span class="p">;</span><span class="nx">strong</span><span class="o">&</span><span class="nx">gt</span><span class="p">;</span><span class="nx">Blue</span><span class="o">&</span><span class="nx">lt</span><span class="p">;</span><span class="o">/</span><span class="nx">strong</span><span class="o">&</span><span class="nx">gt</span><span class="p">;</span><span class="o"></</span><span class="nx">td</span><span class="o">><</span><span class="nx">td</span><span class="o">></span><span class="nx">Small</span><span class="o"></</span><span class="nx">td</span><span class="o">></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::generate">
|
||
<span class="sig-name descname"><span class="pre">generate</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$tableData</span> <span class="pre">=</span> <span class="pre">null</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::generate" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$tableData</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – Data to populate the table rows with</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>HTML table</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::setCaption">
|
||
<span class="sig-name descname"><span class="pre">setCaption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$caption</span></em><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::setCaption" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$caption</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Table caption</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Permits you to add a caption to the table.</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setCaption</span><span class="p">(</span><span class="s1">'Colors'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::setHeading">
|
||
<span class="sig-name descname"><span class="pre">setHeading</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$args</span> <span class="pre">=</span> <span class="pre">[]</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">...</span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::setHeading" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$args</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – An array or multiple strings containing the table column titles</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Permits you to set the table heading. You can submit an array or discrete params:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setHeading</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">);</span> <span class="c1">// or</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setHeading</span><span class="p">([</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">]);</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::setFooting">
|
||
<span class="sig-name descname"><span class="pre">setFooting</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$args</span> <span class="pre">=</span> <span class="pre">[]</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">...</span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::setFooting" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$args</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – An array or multiple strings containing the table footing values</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Permits you to set the table footing. You can submit an array or discrete params:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setFooting</span><span class="p">(</span><span class="s1">'Subtotal'</span><span class="p">,</span> <span class="nv">$subtotal</span><span class="p">,</span> <span class="nv">$notes</span><span class="p">);</span> <span class="c1">// or</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setFooting</span><span class="p">([</span><span class="s1">'Subtotal'</span><span class="p">,</span> <span class="nv">$subtotal</span><span class="p">,</span> <span class="nv">$notes</span><span class="p">]);</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::addRow">
|
||
<span class="sig-name descname"><span class="pre">addRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$args</span> <span class="pre">=</span> <span class="pre">[]</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">...</span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::addRow" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$args</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – An array or multiple strings containing the row values</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Permits you to add a row to your table. You can submit an array or discrete params:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">);</span> <span class="c1">// or</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">([</span><span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">]);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you would like to set an individual cell’s tag attributes, you can use an associative array for that cell.
|
||
The associative key <strong>data</strong> defines the cell’s data. Any other key => val pairs are added as key=’val’ attributes to the tag:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$cell</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'data'</span> <span class="o">=></span> <span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'highlight'</span><span class="p">,</span> <span class="s1">'colspan'</span> <span class="o">=></span> <span class="mi">2</span><span class="p">];</span>
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="nv">$cell</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">);</span>
|
||
|
||
<span class="cp">?></span>
|
||
|
||
<span class="cm"><!-- Generates: --></span>
|
||
<span class="p"><</span><span class="nt">td</span> <span class="na">class</span><span class="o">=</span><span class="s">'highlight'</span> <span class="na">colspan</span><span class="o">=</span><span class="s">'2'</span><span class="p">></span>Blue<span class="p"></</span><span class="nt">td</span><span class="p">><</span><span class="nt">td</span><span class="p">></span>Red<span class="p"></</span><span class="nt">td</span><span class="p">><</span><span class="nt">td</span><span class="p">></span>Green<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::makeColumns">
|
||
<span class="sig-name descname"><span class="pre">makeColumns</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$array</span> <span class="pre">=</span> <span class="pre">[]</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">$columnLimit</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::makeColumns" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$array</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span>) – An array containing multiple rows’ data</p></li>
|
||
<li><p><strong>$columnLimit</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Count of columns in the table</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>An array of HTML table columns</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>This method takes a one-dimensional array as input and creates a multi-dimensional array with a depth equal to the number of columns desired.
|
||
This allows a single array with many elements to be displayed in a table that has a fixed column count. Consider this example:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$list</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">,</span> <span class="s1">'four'</span><span class="p">,</span> <span class="s1">'five'</span><span class="p">,</span> <span class="s1">'six'</span><span class="p">,</span> <span class="s1">'seven'</span><span class="p">,</span> <span class="s1">'eight'</span><span class="p">,</span> <span class="s1">'nine'</span><span class="p">,</span> <span class="s1">'ten'</span><span class="p">,</span> <span class="s1">'eleven'</span><span class="p">,</span> <span class="s1">'twelve'</span><span class="p">];</span>
|
||
|
||
<span class="nv">$newList</span> <span class="o">=</span> <span class="nv">$table</span><span class="o">-></span><span class="na">makeColumns</span><span class="p">(</span><span class="nv">$list</span><span class="p">,</span> <span class="mi">3</span><span class="p">);</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">(</span><span class="nv">$newList</span><span class="p">);</span>
|
||
|
||
<span class="cp">?></span>
|
||
|
||
<span class="cm"><!-- Generates a table with this prototype: --></span>
|
||
<span class="p"><</span><span class="nt">table</span> <span class="na">border</span><span class="o">=</span><span class="s">"0"</span> <span class="na">cellpadding</span><span class="o">=</span><span class="s">"4"</span> <span class="na">cellspacing</span><span class="o">=</span><span class="s">"0"</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>one<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>two<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>three<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>four<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>five<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>six<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>seven<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>eight<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>nine<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>ten<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>eleven<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"><</span><span class="nt">td</span><span class="p">></span>twelve<span class="p"></</span><span class="nt">td</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">tr</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">table</span><span class="p">></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::setTemplate">
|
||
<span class="sig-name descname"><span class="pre">setTemplate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$template</span></em><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::setTemplate" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$template</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span>) – An associative array containing template values</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>true on success, false on failure</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Permits you to set your template. You can submit a full or partial template.</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$template</span> <span class="o">=</span> <span class="p">[</span>
|
||
<span class="s1">'table_open'</span> <span class="o">=></span> <span class="s1">'<table border="1" cellpadding="2" cellspacing="1" class="mytable">'</span><span class="p">,</span>
|
||
<span class="p">];</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setTemplate</span><span class="p">(</span><span class="nv">$template</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::setEmpty">
|
||
<span class="sig-name descname"><span class="pre">setEmpty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::setEmpty" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>$value</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – Value to put in empty cells</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Lets you set a default value for use in any table cells that are empty.
|
||
You might, for example, set a non-breaking space:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setEmpty</span><span class="p">(</span><span class="s1">'&nbsp;'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\View\Table::clear">
|
||
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\View\Table::clear" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Table instance (method chaining)</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><a class="reference internal" href="#CodeIgniter\View\Table" title="CodeIgniter\View\Table"><code class="xref php php-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Lets you clear the table heading, row data and caption. If
|
||
you need to show multiple tables with different data you
|
||
should to call this method after each table has been
|
||
generated to clear the previous table information.</p>
|
||
<p>Example</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span>
|
||
|
||
<span class="nv">$table</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\View\Table</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setCaption</span><span class="p">(</span><span class="s1">'Preferences'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">setHeading</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Color'</span><span class="p">,</span> <span class="s1">'Size'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'Blue'</span><span class="p">,</span> <span class="s1">'Small'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Mary'</span><span class="p">,</span> <span class="s1">'Red'</span><span class="p">,</span> <span class="s1">'Large'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span> <span class="s1">'Green'</span><span class="p">,</span> <span class="s1">'Medium'</span><span class="p">);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">clear</span><span class="p">();</span>
|
||
|
||
<span class="nv">$table</span><span class="o">-></span><span class="na">setCaption</span><span class="p">(</span><span class="s1">'Shipping'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">setHeading</span><span class="p">(</span><span class="s1">'Name'</span><span class="p">,</span> <span class="s1">'Day'</span><span class="p">,</span> <span class="s1">'Delivery'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Fred'</span><span class="p">,</span> <span class="s1">'Wednesday'</span><span class="p">,</span> <span class="s1">'Express'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'Mary'</span><span class="p">,</span> <span class="s1">'Monday'</span><span class="p">,</span> <span class="s1">'Air'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">addRow</span><span class="p">(</span><span class="s1">'John'</span><span class="p">,</span> <span class="s1">'Saturday'</span><span class="p">,</span> <span class="s1">'Overnight'</span><span class="p">);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$table</span><span class="o">-></span><span class="na">generate</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="view_decorators.html" class="btn btn-neutral float-left" title="View Decorators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="response.html" class="btn btn-neutral float-right" title="HTTP Responses" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2019-2023 CodeIgniter Foundation.
|
||
<span class="lastupdated">Last updated on Aug 25, 2023.
|
||
</span></p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(false);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |