mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
1106 lines
80 KiB
HTML
1106 lines
80 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>Generating Query Results — CodeIgniter 4.2.6 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="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="Query Helper Methods" href="helpers.html" />
|
||
<link rel="prev" title="Queries" href="queries.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" style="background: #DD4814" >
|
||
<a href="../index.html">
|
||
<img src="../_static/ci-logo-text.png" 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" />
|
||
<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>
|
||
<li class="toctree-l1"><a class="reference internal" href="../outgoing/index.html">Building Responses</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/views.html">Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_cells.html">View Cells</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_renderer.html">View Renderer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_layouts.html">View Layouts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_parser.html">View Parser</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_decorators.html">View Decorators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/table.html">HTML Table Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/response.html">HTTP Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/api_responses.html">API Response Trait</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/localization.html">Localization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Working With Databases</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html">Quick Start: Usage Examples</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Database Configuration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="connecting.html">Connecting to a Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="queries.html">Running Queries</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Generating Query Results</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="helpers.html">Query Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="query_builder.html">Query Builder Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="transactions.html">Transactions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="metadata.html">Getting MetaData</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="call_function.html">Custom Function Calls</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="events.html">Database Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="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/files.html#file-collections">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/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" style="background: #DD4814" >
|
||
<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/database/results.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"></a> »</li>
|
||
<li><a href="index.html">Working With Databases</a> »</li>
|
||
<li>Generating Query Results</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="generating-query-results">
|
||
<h1>Generating Query Results<a class="headerlink" href="#generating-query-results" title="Permalink to this headline"></a></h1>
|
||
<p>There are several ways to generate query results:</p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#result-arrays" id="id1">Result Arrays</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#getresult" id="id2">getResult()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getresultarray" id="id3">getResultArray()</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#result-rows" id="id4">Result Rows</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#getrow" id="id5">getRow()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getrowarray" id="id6">getRowArray()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getunbufferedrow" id="id7">getUnbufferedRow()</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#custom-result-objects" id="id8">Custom Result Objects</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#getcustomresultobject" id="id9">getCustomResultObject()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getcustomrowobject" id="id10">getCustomRowObject()</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#result-helper-methods" id="id11">Result Helper Methods</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#getfieldcount" id="id12">getFieldCount()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getfieldnames" id="id13">getFieldNames()</a></p></li>
|
||
<li><p><a class="reference internal" href="#getnumrows" id="id14">getNumRows()</a></p></li>
|
||
<li><p><a class="reference internal" href="#freeresult" id="id15">freeResult()</a></p></li>
|
||
<li><p><a class="reference internal" href="#dataseek" id="id16">dataSeek()</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#namespace-CodeIgniter\Database" id="id17">Class Reference</a></p></li>
|
||
</ul>
|
||
</div>
|
||
<section id="result-arrays">
|
||
<h2><a class="toc-backref" href="#id1">Result Arrays</a><a class="headerlink" href="#result-arrays" title="Permalink to this headline"></a></h2>
|
||
<section id="getresult">
|
||
<h3><a class="toc-backref" href="#id2">getResult()</a><a class="headerlink" href="#getresult" title="Permalink to this headline"></a></h3>
|
||
<p>This method returns the query result as an array of <strong>objects</strong>, or
|
||
<strong>an empty array</strong> on failure. Typically you’ll use this in a foreach
|
||
loop, like this:</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$query</span><span class="o">-></span><span class="na">getResult</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">title</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">body</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The above method is an alias of <code class="docutils literal notranslate"><span class="pre">getResultObject()</span></code>.</p>
|
||
<p>You can pass in the string ‘array’ if you wish to get your results
|
||
as an array of arrays:</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$query</span><span class="o">-></span><span class="na">getResult</span><span class="p">(</span><span class="s1">'array'</span><span class="p">)</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'title'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'name'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'body'</span><span class="p">];</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The above usage is an alias of <code class="docutils literal notranslate"><span class="pre">getResultArray()</span></code>.</p>
|
||
<p>You can also pass a string to <code class="docutils literal notranslate"><span class="pre">getResult()</span></code> which represents a class to
|
||
instantiate for each result object</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">$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 users;'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$query</span><span class="o">-></span><span class="na">getResult</span><span class="p">(</span><span class="s1">'User'</span><span class="p">)</span> <span class="k">as</span> <span class="nv">$user</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$user</span><span class="o">-></span><span class="na">name</span><span class="p">;</span> <span class="c1">// access attributes</span>
|
||
<span class="k">echo</span> <span class="nv">$user</span><span class="o">-></span><span class="na">reverseName</span><span class="p">();</span> <span class="c1">// or methods defined on the 'User' class</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The above method is an alias of <code class="docutils literal notranslate"><span class="pre">getCustomResultObject()</span></code>.</p>
|
||
</section>
|
||
<section id="getresultarray">
|
||
<h3><a class="toc-backref" href="#id3">getResultArray()</a><a class="headerlink" href="#getresultarray" title="Permalink to this headline"></a></h3>
|
||
<p>This method returns the query result as a pure array, or an empty
|
||
array when no result is produced. Typically you’ll use this in a foreach
|
||
loop, like this:</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$query</span><span class="o">-></span><span class="na">getResultArray</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'title'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'name'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'body'</span><span class="p">];</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="result-rows">
|
||
<h2><a class="toc-backref" href="#id4">Result Rows</a><a class="headerlink" href="#result-rows" title="Permalink to this headline"></a></h2>
|
||
<section id="getrow">
|
||
<h3><a class="toc-backref" href="#id5">getRow()</a><a class="headerlink" href="#getrow" title="Permalink to this headline"></a></h3>
|
||
<p>This method returns a single result row. If your query has more than
|
||
one row, it returns only the first row. The result is returned as an
|
||
<strong>object</strong>. Here’s a usage 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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getRow</span><span class="p">();</span>
|
||
|
||
<span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$row</span><span class="p">))</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">title</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">body</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you want a specific row returned you can submit the row number as a
|
||
digit in the first parameter:</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">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getRow</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also add a second String parameter, which is the name of a class
|
||
to instantiate the row with:</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">$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 users LIMIT 1;'</span><span class="p">);</span>
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getRow</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s1">'User'</span><span class="p">);</span>
|
||
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">name</span><span class="p">;</span> <span class="c1">// access attributes</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">reverse_name</span><span class="p">();</span> <span class="c1">// or methods defined on the 'User' class</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="getrowarray">
|
||
<h3><a class="toc-backref" href="#id6">getRowArray()</a><a class="headerlink" href="#getrowarray" title="Permalink to this headline"></a></h3>
|
||
<p>Identical to the above <code class="docutils literal notranslate"><span class="pre">row()</span></code> method, except it returns an array.
|
||
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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getRowArray</span><span class="p">();</span>
|
||
|
||
<span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$row</span><span class="p">))</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'title'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'name'</span><span class="p">];</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="p">[</span><span class="s1">'body'</span><span class="p">];</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you want a specific row returned you can submit the row number as a
|
||
digit in the first parameter:</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">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getRowArray</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>In addition, you can walk forward/backwards/first/last through your
|
||
results using these variations:</p>
|
||
<blockquote>
|
||
<div><div class="line-block">
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getFirstRow()</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getLastRow()</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getNextRow()</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getPreviousRow()</span></code></div>
|
||
</div>
|
||
</div></blockquote>
|
||
<p>By default they return an object unless you put the word “array” in the
|
||
parameter:</p>
|
||
<blockquote>
|
||
<div><div class="line-block">
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getFirstRow('array')</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getLastRow('array')</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getNextRow('array')</span></code></div>
|
||
<div class="line"><code class="docutils literal notranslate"><span class="pre">$row</span> <span class="pre">=</span> <span class="pre">$query->getPreviousRow('array')</span></code></div>
|
||
</div>
|
||
</div></blockquote>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>All the methods above will load the whole result into memory
|
||
(prefetching). Use <code class="docutils literal notranslate"><span class="pre">getUnbufferedRow()</span></code> for processing large
|
||
result sets.</p>
|
||
</div>
|
||
</section>
|
||
<section id="getunbufferedrow">
|
||
<h3><a class="toc-backref" href="#id7">getUnbufferedRow()</a><a class="headerlink" href="#getunbufferedrow" title="Permalink to this headline"></a></h3>
|
||
<p>This method returns a single result row without prefetching the whole
|
||
result in memory as <code class="docutils literal notranslate"><span class="pre">row()</span></code> does. If your query has more than one row,
|
||
it returns the current row and moves the internal data pointer ahead.</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="k">while</span> <span class="p">(</span><span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">())</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">title</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">body</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>For use with MySQLi you may set MySQLi’s result mode to
|
||
<code class="docutils literal notranslate"><span class="pre">MYSQLI_USE_RESULT</span></code> for maximum memory savings. Use of this is not
|
||
generally recommended but it can be beneficial in some circumstances
|
||
such as writing large queries to csv. If you change the result mode
|
||
be aware of the tradeoffs associated with it.</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">$db</span><span class="o">-></span><span class="na">resultMode</span> <span class="o">=</span> <span class="nx">MYSQLI_USE_RESULT</span><span class="p">;</span> <span class="c1">// for unbuffered results</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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$file</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\CodeIgniter\Files\File</span><span class="p">(</span><span class="nx">WRITEPATH</span> <span class="o">.</span> <span class="s1">'data.csv'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$csv</span> <span class="o">=</span> <span class="nv">$file</span><span class="o">-></span><span class="na">openFile</span><span class="p">(</span><span class="s1">'w'</span><span class="p">);</span>
|
||
|
||
<span class="k">while</span> <span class="p">(</span><span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">(</span><span class="s1">'array'</span><span class="p">))</span> <span class="p">{</span>
|
||
<span class="nv">$csv</span><span class="o">-></span><span class="na">fputcsv</span><span class="p">(</span><span class="nv">$row</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="nv">$db</span><span class="o">-></span><span class="na">resultMode</span> <span class="o">=</span> <span class="nx">MYSQLI_STORE_RESULT</span><span class="p">;</span> <span class="c1">// return to default mode</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>When using <code class="docutils literal notranslate"><span class="pre">MYSQLI_USE_RESULT</span></code> all subsequent calls on the same
|
||
connection will result in error until all records have been fetched or
|
||
a <code class="docutils literal notranslate"><span class="pre">freeResult()</span></code> call has been made. The <code class="docutils literal notranslate"><span class="pre">getNumRows()</span></code> method will only
|
||
return the number of rows based on the current position of the data pointer.
|
||
MyISAM tables will remain locked until all the records have been fetched
|
||
or a <code class="docutils literal notranslate"><span class="pre">freeResult()</span></code> call has been made.</p>
|
||
</div>
|
||
<p>You can optionally pass ‘object’ (default) or ‘array’ in order to specify
|
||
the returned value’s type:</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">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">();</span> <span class="c1">// object</span>
|
||
<span class="nv">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">(</span><span class="s1">'object'</span><span class="p">);</span> <span class="c1">// object</span>
|
||
<span class="nv">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">(</span><span class="s1">'array'</span><span class="p">);</span> <span class="c1">// associative array</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="custom-result-objects">
|
||
<h2><a class="toc-backref" href="#id8">Custom Result Objects</a><a class="headerlink" href="#custom-result-objects" title="Permalink to this headline"></a></h2>
|
||
<p>You can have the results returned as an instance of a custom class instead
|
||
of a <code class="docutils literal notranslate"><span class="pre">stdClass</span></code> or array, as the <code class="docutils literal notranslate"><span class="pre">getResult()</span></code> and <code class="docutils literal notranslate"><span class="pre">getResultArray()</span></code>
|
||
methods allow. If the class is not already loaded into memory, the Autoloader
|
||
will attempt to load it. The object will have all values returned from the
|
||
database set as properties. If these have been declared and are non-public
|
||
then you should provide a <code class="docutils literal notranslate"><span class="pre">__set()</span></code> method to allow them to be set.</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="k">class</span> <span class="nc">User</span>
|
||
<span class="p">{</span>
|
||
<span class="k">public</span> <span class="nv">$id</span><span class="p">;</span>
|
||
<span class="k">public</span> <span class="nv">$email</span><span class="p">;</span>
|
||
<span class="k">public</span> <span class="nv">$username</span><span class="p">;</span>
|
||
|
||
<span class="k">protected</span> <span class="nv">$last_login</span><span class="p">;</span>
|
||
|
||
<span class="k">public</span> <span class="k">function</span> <span class="nf">lastLogin</span><span class="p">(</span><span class="nv">$format</span><span class="p">)</span>
|
||
<span class="p">{</span>
|
||
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="na">lastLogin</span><span class="o">-></span><span class="na">format</span><span class="p">(</span><span class="nv">$format</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="k">public</span> <span class="k">function</span> <span class="fm">__set</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$value</span><span class="p">)</span>
|
||
<span class="p">{</span>
|
||
<span class="k">if</span> <span class="p">(</span><span class="nv">$name</span> <span class="o">===</span> <span class="s1">'lastLogin'</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nv">$this</span><span class="o">-></span><span class="na">lastLogin</span> <span class="o">=</span> <span class="nx">DateTime</span><span class="o">::</span><span class="na">createFromFormat</span><span class="p">(</span><span class="s1">'!U'</span><span class="p">,</span> <span class="nv">$value</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="k">public</span> <span class="k">function</span> <span class="fm">__get</span><span class="p">(</span><span class="nv">$name</span><span class="p">)</span>
|
||
<span class="p">{</span>
|
||
<span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="p">{</span><span class="nv">$name</span><span class="p">}))</span> <span class="p">{</span>
|
||
<span class="k">return</span> <span class="nv">$this</span><span class="o">-></span><span class="p">{</span><span class="nv">$name</span><span class="p">};</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>In addition to the two methods listed below, the following methods also can
|
||
take a class name to return the results as: <code class="docutils literal notranslate"><span class="pre">getFirstRow()</span></code>, <code class="docutils literal notranslate"><span class="pre">getLastRow()</span></code>,
|
||
<code class="docutils literal notranslate"><span class="pre">getNextRow()</span></code>, and <code class="docutils literal notranslate"><span class="pre">getPreviousRow()</span></code>.</p>
|
||
<section id="getcustomresultobject">
|
||
<h3><a class="toc-backref" href="#id9">getCustomResultObject()</a><a class="headerlink" href="#getcustomresultobject" title="Permalink to this headline"></a></h3>
|
||
<p>Returns the entire result set as an array of instances of the class requested.
|
||
The only parameter is the name of the class to instantiate.</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$rows</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getCustomResultObject</span><span class="p">(</span><span class="s1">'User'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$rows</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">id</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">email</span><span class="p">;</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">last_login</span><span class="p">(</span><span class="s1">'Y-m-d'</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="getcustomrowobject">
|
||
<h3><a class="toc-backref" href="#id10">getCustomRowObject()</a><a class="headerlink" href="#getcustomrowobject" title="Permalink to this headline"></a></h3>
|
||
<p>Returns a single row from your query results. The first parameter is the row
|
||
number of the results. The second parameter is the class name to instantiate.</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">$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">'YOUR QUERY'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getCustomRowObject</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s1">'User'</span><span class="p">);</span>
|
||
|
||
<span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$row</span><span class="p">))</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">email</span><span class="p">;</span> <span class="c1">// access attributes</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">last_login</span><span class="p">(</span><span class="s1">'Y-m-d'</span><span class="p">);</span> <span class="c1">// access class methods</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also use the <code class="docutils literal notranslate"><span class="pre">getRow()</span></code> method in exactly the same way.</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">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getCustomRowObject</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s1">'User'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="result-helper-methods">
|
||
<h2><a class="toc-backref" href="#id11">Result Helper Methods</a><a class="headerlink" href="#result-helper-methods" title="Permalink to this headline"></a></h2>
|
||
<section id="getfieldcount">
|
||
<h3><a class="toc-backref" href="#id12">getFieldCount()</a><a class="headerlink" href="#getfieldcount" title="Permalink to this headline"></a></h3>
|
||
<p>The number of FIELDS (columns) returned by the query. Make sure to call
|
||
the method using your query result object:</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">$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">$query</span><span class="o">-></span><span class="na">getFieldCount</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="getfieldnames">
|
||
<h3><a class="toc-backref" href="#id13">getFieldNames()</a><a class="headerlink" href="#getfieldnames" title="Permalink to this headline"></a></h3>
|
||
<p>Returns an array with the names of the FIELDS (columns) returned by the query.
|
||
Make sure to call the method using your query result object:</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">$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">$query</span><span class="o">-></span><span class="na">getFieldNames</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="getnumrows">
|
||
<h3><a class="toc-backref" href="#id14">getNumRows()</a><a class="headerlink" href="#getnumrows" title="Permalink to this headline"></a></h3>
|
||
<p>The number of records returned by the query. Make sure to call
|
||
the method using your query result object:</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">$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">$query</span><span class="o">-></span><span class="na">getNumRows</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Because SQLite3 lacks an efficient method returning a record count,
|
||
CodeIgniter will fetch and buffer the query result records internally and
|
||
return a count of the resulting record array, which can be inefficient.</p>
|
||
</div>
|
||
</section>
|
||
<section id="freeresult">
|
||
<h3><a class="toc-backref" href="#id15">freeResult()</a><a class="headerlink" href="#freeresult" title="Permalink to this headline"></a></h3>
|
||
<p>It frees the memory associated with the result and deletes the result
|
||
resource ID. Normally PHP frees its memory automatically at the end of
|
||
script execution. However, if you are running a lot of queries in a
|
||
particular script you might want to free the result after each query
|
||
result has been generated in order to cut down on memory consumption.</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">$query</span> <span class="o">=</span> <span class="nv">$thisdb</span><span class="o">-></span><span class="na">query</span><span class="p">(</span><span class="s1">'SELECT title FROM my_table'</span><span class="p">);</span>
|
||
|
||
<span class="k">foreach</span> <span class="p">(</span><span class="nv">$query</span><span class="o">-></span><span class="na">getResult</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$row</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">title</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="nv">$query</span><span class="o">-></span><span class="na">freeResult</span><span class="p">();</span> <span class="c1">// The $query result object will no longer be available</span>
|
||
|
||
<span class="nv">$query2</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 name FROM some_table'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query2</span><span class="o">-></span><span class="na">getRow</span><span class="p">();</span>
|
||
<span class="k">echo</span> <span class="nv">$row</span><span class="o">-></span><span class="na">name</span><span class="p">;</span>
|
||
<span class="nv">$query2</span><span class="o">-></span><span class="na">freeResult</span><span class="p">();</span> <span class="c1">// The $query2 result object will no longer be available</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="dataseek">
|
||
<h3><a class="toc-backref" href="#id16">dataSeek()</a><a class="headerlink" href="#dataseek" title="Permalink to this headline"></a></h3>
|
||
<p>This method sets the internal pointer for the next result row to be
|
||
fetched. It is only useful in combination with <code class="docutils literal notranslate"><span class="pre">getUnbufferedRow()</span></code>.</p>
|
||
<p>It accepts a positive integer value, which defaults to 0 and returns
|
||
true on success or false on failure.</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">$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 `field_name` FROM `table_name`'</span><span class="p">);</span>
|
||
<span class="nv">$query</span><span class="o">-></span><span class="na">dataSeek</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span> <span class="c1">// Skip the first 5 rows</span>
|
||
<span class="nv">$row</span> <span class="o">=</span> <span class="nv">$query</span><span class="o">-></span><span class="na">getUnbufferedRow</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Not all database drivers support this feature and will return false.
|
||
Most notably - you won’t be able to use it with PDO.</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="namespace-CodeIgniter\Database">
|
||
<span id="class-reference"></span><h2><a class="toc-backref" href="#id17">Class Reference</a><a class="headerlink" href="#namespace-CodeIgniter\Database" title="Permalink to this headline"></a></h2>
|
||
<dl class="php class">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">CodeIgniter\Database\</span></span><span class="sig-name descname"><span class="pre">BaseResult</span></span><a class="headerlink" href="#CodeIgniter\Database\BaseResult" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getResult">
|
||
<span class="sig-name descname"><span class="pre">getResult</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getResult" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of requested results - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Array containing the fetched rows</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>A wrapper for the <code class="docutils literal notranslate"><span class="pre">getResultArray()</span></code>, <code class="docutils literal notranslate"><span class="pre">getResultObject()</span></code>
|
||
and <code class="docutils literal notranslate"><span class="pre">getCustomResultObject()</span></code> methods.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-arrays">Result Arrays</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getResultArray">
|
||
<span class="sig-name descname"><span class="pre">getResultArray</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getResultArray" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Array containing the fetched rows</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the query results as an array of rows, where each
|
||
row is itself an associative array.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-arrays">Result Arrays</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getResultObject">
|
||
<span class="sig-name descname"><span class="pre">getResultObject</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getResultObject" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Array containing the fetched rows</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the query results as an array of rows, where each
|
||
row is an object of type <code class="docutils literal notranslate"><span class="pre">stdClass</span></code>.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-arrays">Result Arrays</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getCustomResultObject">
|
||
<span class="sig-name descname"><span class="pre">getCustomResultObject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$class_name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getCustomResultObject" 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>$class_name</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Class name for the resulting rows</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Array containing the fetched rows</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>Returns the query results as an array of rows, where each
|
||
row is an instance of the specified class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getRow">
|
||
<span class="sig-name descname"><span class="pre">getRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$n</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getRow" 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>$n</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Index of the query results row to be returned</p></li>
|
||
<li><p><strong>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The requested row or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>A wrapper for the <code class="docutils literal notranslate"><span class="pre">getRowArray()</span></code>, <code class="docutils literal notranslate"><span class="pre">getRowObject()</span></code> and
|
||
<code class="docutils literal notranslate"><span class="pre">getCustomRowObject()</span></code> methods.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-rows">Result Rows</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getUnbufferedRow">
|
||
<span class="sig-name descname"><span class="pre">getUnbufferedRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getUnbufferedRow" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Next row from the result set or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Fetches the next result row and returns it in the
|
||
requested form.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-rows">Result Rows</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getRowArray">
|
||
<span class="sig-name descname"><span class="pre">getRowArray</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$n</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getRowArray" 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>$n</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Index of the query results row to be returned</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The requested row or null if it doesn’t exist</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>Returns the requested result row as an associative array.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-rows">Result Rows</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getRowObject">
|
||
<span class="sig-name descname"><span class="pre">getRowObject</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$n</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getRowObject" 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>$n</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Index of the query results row to be returned
|
||
:returns: The requested row or null if it doesn’t exist</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">stdClass</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the requested result row as an object of type
|
||
<code class="docutils literal notranslate"><span class="pre">stdClass</span></code>.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-rows">Result Rows</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getCustomRowObject">
|
||
<span class="sig-name descname"><span class="pre">getCustomRowObject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$n</span></em>, <em class="sig-param"><span class="pre">$type</span></em><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getCustomRowObject" 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>$n</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Index of the results row to return</p></li>
|
||
<li><p><strong>$class_name</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Class name for the resulting row</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The requested row or null if it doesn’t exist</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">$type</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the requested result row as an instance of the
|
||
requested class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::dataSeek">
|
||
<span class="sig-name descname"><span class="pre">dataSeek</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$n</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::dataSeek" 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>$n</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span>) – Index of the results row to be returned next</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>Moves the internal results row pointer to the desired offset.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-helper-methods">Result Helper Methods</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::setRow">
|
||
<span class="sig-name descname"><span class="pre">setRow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">$key</span></em><span class="optional">[</span>, <em class="sig-param"><span class="pre">$value</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\Database\BaseResult::setRow" 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>$key</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – Column name or array of key/value pairs</p></li>
|
||
<li><p><strong>$value</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">mixed</span></code></span>) – Value to assign to the column, $key is a single field name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">void</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Assigns a value to a particular column.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getNextRow">
|
||
<span class="sig-name descname"><span class="pre">getNextRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getNextRow" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Next row of result set, or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the next row from the result set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getPreviousRow">
|
||
<span class="sig-name descname"><span class="pre">getPreviousRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getPreviousRow" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Previous row of result set, or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the previous row from the result set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getFirstRow">
|
||
<span class="sig-name descname"><span class="pre">getFirstRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getFirstRow" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>First row of result set, or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the first row from the result set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getLastRow">
|
||
<span class="sig-name descname"><span class="pre">getLastRow</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="pre">$type</span> <span class="pre">=</span> <span class="pre">'object'</span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getLastRow" 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>$type</strong> (<span><code class="xref php php-obj docutils literal notranslate"><span class="pre">string</span></code></span>) – Type of the requested result - array, object, or class name</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Last row of result set, or null if it doesn’t exist</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">mixed</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the last row from the result set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getFieldCount">
|
||
<span class="sig-name descname"><span class="pre">getFieldCount</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getFieldCount" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Number of fields in the result set</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns the number of fields in the result set.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-helper-methods">Result Helper Methods</a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getFieldNames">
|
||
<span class="sig-name descname"><span class="pre">getFieldNames</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getFieldNames" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Array of column names</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns an array containing the field names in the
|
||
result set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getFieldData">
|
||
<span class="sig-name descname"><span class="pre">getFieldData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getFieldData" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Array containing field meta-data</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">array</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Generates an array of <code class="docutils literal notranslate"><span class="pre">stdClass</span></code> objects containing
|
||
field meta-data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::getNumRows">
|
||
<span class="sig-name descname"><span class="pre">getNumRows</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::getNumRows" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Number of rows in result set</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><span><code class="xref php php-obj docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Returns number of rows returned by the query</p>
|
||
</dd></dl>
|
||
|
||
<dl class="php method">
|
||
<dt class="sig sig-object php" id="CodeIgniter\Database\BaseResult::freeResult">
|
||
<span class="sig-name descname"><span class="pre">freeResult</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CodeIgniter\Database\BaseResult::freeResult" title="Permalink to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<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">void</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Frees a result set.</p>
|
||
<p>Usage: see <a class="reference internal" href="#result-helper-methods">Result Helper Methods</a>.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="queries.html" class="btn btn-neutral float-left" title="Queries" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="helpers.html" class="btn btn-neutral float-right" title="Query Helper Methods" 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-2022 CodeIgniter Foundation.
|
||
<span class="lastupdated">Last updated on Sep 30, 2022.
|
||
</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> |