opencart/docs/api/Opencart.Admin.Model.Localisation.Country.html
2024-03-04 23:29:14 +08:00

593 lines
17 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Class Opencart\Admin\Model\Localisation\Country | OpenCart API API</title>
<link rel="stylesheet" href="http://localhost\opencart-master/docs/api/assets/main.css">
<script src="http://localhost\opencart-master/docs/api/assets/main.js" defer></script>
</head>
<body class="layout">
<div class="layout-aside">
<div class="menu">
<div class="menu-section">
<h3>Namespaces</h3>
<ul>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>
<ul>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.html">Admin</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Controller.html">Controller</a>
</li>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.html">Model</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Catalog.html">Catalog</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Cms.html">Cms</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Customer.html">Customer</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Design.html">Design</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Extension.html">Extension</a>
</li>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Localisation.html">Localisation</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Marketing.html">Marketing</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Report.html">Report</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Sale.html">Sale</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Setting.html">Setting</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Tool.html">Tool</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.User.html">User</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Catalog.html">Catalog</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>
</li>
</ul>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-none.html">none</a>
</li>
</ul>
</div>
<div class="menu-section">
<h3>Classes</h3>
<ul>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.AddressFormat.html">
AddressFormat
</a>
</li>
<li class="active">
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Country.html">
Country
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Currency.html">
Currency
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.GeoZone.html">
GeoZone
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Language.html">
Language
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.LengthClass.html">
LengthClass
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Location.html">
Location
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.OrderStatus.html">
OrderStatus
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.ReturnAction.html">
ReturnAction
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.ReturnReason.html">
ReturnReason
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.ReturnStatus.html">
ReturnStatus
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.StockStatus.html">
StockStatus
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.SubscriptionStatus.html">
SubscriptionStatus
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.TaxClass.html">
TaxClass
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.TaxRate.html">
TaxRate
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.WeightClass.html">
WeightClass
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Zone.html">
Zone
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="layout-main">
<div class="layout-navbar">
<nav class="navbar">
<div class="navbar-left">
<ul class="navbar-links">
<li>
<a href="http://localhost\opencart-master/docs/api/index.html">Overview</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Localisation.html">Namespace</a>
</li>
<li class="active"><a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Country.html">Class</a></li> <li>
<a href="http://localhost\opencart-master/docs/api/tree.html">Tree</a>
</li>
</ul>
</div>
<div class="navbar-right">
<div class="search" data-elements="http://localhost\opencart-master/docs/api/assets/elements.js">
<input class="search-input" placeholder="Search class, function or namespace" autofocus>
<ul class="search-results"></ul>
</div>
</div>
</nav>
</div>
<div class="layout-content">
<h1>
Class <a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.html">Admin</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.html">Model</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.Model.Localisation.html">Localisation</a>\<a href="http://localhost\opencart-master/docs/api/Opencart.Admin.Model.Localisation.Country.html">Country</a>
</h1>
<table class="classLikeSignatureTable">
<tr>
<th><code>extends</code></th>
<td>
<code><a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html"><span title="Opencart\System\Engine\Model">Model</span></a></code> </td>
</tr>
</table>
<div class="classLikeDescription">
<div class="description"><p>Class Country</p>
</div>
</div>
<div class="classLikeSection">
<ul class="classTree">
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html"><span>Opencart\System\Engine\Model</span></a>
<ul class="classTree">
<li>
<b><span class="active">Opencart\Admin\Model\Localisation\Country</span></b>
</li>
</ul>
</li>
</ul>
</div>
<div class="classLikeSection">
<b>Located at</b> <a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#8" title="Go to source code">admin\model\localisation\country.php</a><br>
</div>
<table class="table" id="methods">
<tr>
<th class="table-heading sortable" colspan="3" title="Switch between natural and alphabetical order">Methods</th>
</tr>
<tr class="expandable collapsed" data-order="addCountry" id="_addCountry">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#9-22" title="Go to source code">addCountry</a>(<span>array&lt;string, mixed&gt; <var>$data</var></span>): int</code>
<div class="expandable-collapsedView">
<p>Add Country</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Add Country</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_addCountry">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="editCountry" id="_editCountry">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#24-36" title="Go to source code">editCountry</a>(<span>int <var>$country_id</var></span>, <span>array&lt;string, mixed&gt; <var>$data</var></span>): void</code>
<div class="expandable-collapsedView">
<p>Edit Country</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Edit Country</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_editCountry">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="deleteCountry" id="_deleteCountry">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#38-49" title="Go to source code">deleteCountry</a>(<span>int <var>$country_id</var></span>): void</code>
<div class="expandable-collapsedView">
<p>Delete Country</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Delete Country</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_deleteCountry">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getCountry" id="_getCountry">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#51-62" title="Go to source code">getCountry</a>(<span>int <var>$country_id</var></span>): array&lt;string, mixed&gt;</code>
<div class="expandable-collapsedView">
<p>Get Country</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Country</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getCountry">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getCountryByIsoCode2" id="_getCountryByIsoCode2">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#64-75" title="Go to source code">getCountryByIsoCode2</a>(<span>string <var>$iso_code_2</var></span>): array&lt;string, mixed&gt;</code>
<div class="expandable-collapsedView">
<p>Get Country By Iso Code 2</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Country By Iso Code 2</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getCountryByIsoCode2">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getCountryByIsoCode3" id="_getCountryByIsoCode3">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#77-88" title="Go to source code">getCountryByIsoCode3</a>(<span>string <var>$iso_code_3</var></span>): array&lt;string, mixed&gt;</code>
<div class="expandable-collapsedView">
<p>Get Country By Iso Code 3</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Country By Iso Code 3</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getCountryByIsoCode3">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getCountries" id="_getCountries">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#90-161" title="Go to source code">getCountries</a>(<span>array&lt;string, mixed&gt; <var>$data</var> = []</span>): array&lt;int, array&lt;string, mixed&gt;&gt;</code>
<div class="expandable-collapsedView">
<p>Get Countries</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Countries</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getCountries">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getTotalCountries" id="_getTotalCountries">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#163-194" title="Go to source code">getTotalCountries</a>(<span>array&lt;string, mixed&gt; <var>$data</var> = []</span>): int</code>
<div class="expandable-collapsedView">
<p>Get Total Countries</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Total Countries</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getTotalCountries">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getTotalCountriesByAddressFormatId" id="_getTotalCountriesByAddressFormatId">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-admin.model.localisation.country.html#196-207" title="Go to source code">getTotalCountriesByAddressFormatId</a>(<span>int <var>$address_format_id</var></span>): int</code>
<div class="expandable-collapsedView">
<p>Get Total Countries By Address Format ID</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Get Total Countries By Address Format ID</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getTotalCountriesByAddressFormatId">#</a>
</td>
</tr>
</table>
<table class="table">
<tr>
<th class="table-heading">Methods inherited from <a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html"><span>Opencart\System\Engine\Model</span></a></th>
</tr>
<tr>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html#___construct">__construct()</a>, <a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html#___get">__get()</a>, <a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html#___set">__set()</a>, <a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html#___isset">__isset()</a></code> </td>
</tr>
</table>
<table class="table">
<tr>
<th class="table-heading">Properties inherited from <a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html"><span>Opencart\System\Engine\Model</span></a></th>
</tr>
<tr>
<td class="table-cell">
<code><var><a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Model.html#$registry">$registry</a></var></code> </td>
</tr>
</table>
</div>
<div class="layout-footer">
OpenCart API API documentation generated by <a href="https://www.apigen.org">ApiGen dev-master</a>
</div>
</div>
<div class="layout-rest">
<div class="navbar"></div>
</div>
</body>
</html>