Create an OpenCart tool for exporting product CSV files

If you are running an online store or any web business and you don’t know the importance of CSV (Comma Separated Values), then it’s time to upgrade your knowledge about data manipulation. To understand its importance, let’s examine a scenario involving an OpenCart store and see how a product CSV export tool can be built as a solution.

Suppose you are running an online store with thousands of items, and you have to change the prices of all items for a special event. There may be two possible solutions:

1. Go to the product's control panel (admin panel) and manually change the prices one by one.
2. Give the relevant person direct access to the database and let him or her use your data.

In the first case, when you have to change the item price one by one according to the user interface provided by the store admin panel, this is a safe method, but changing the price of thousands of items may take a lot of time—— It may take several weeks for large amounts of data.

In the second case, security issues may arise when you provide direct access to the store database. Sometimes, serious problems can occur that cause your system to crash.

What is the solution?

So there must be a mechanism to format the projects and you can batch import/export them directly into your system. CSV is the best solution. That's what we'll do in the tutorial.

What is CSV?

CSV is short for "Comma Separated Values". It is a method of formatting information taken from a database so that it can be read and edited in ordinary spreadsheet software. You can then add large amounts of information back to the database.

Product Export in OpenCart

Considering the above scenario, sometimes it is difficult to add and edit products in bulk, so we will create a CSV export tool in the system. This way we can provide all of our products in a specific format so we can easily read, add and edit the information later. Let's start by building the export tool.

1. Export button in product page

1.1 Controller

1. Navigate to (your opencart store directory)/admin/controller/catalog/product.php.
2. Find the getList() function.
3. Add the following lines after this line of code:

$this->data['products'] = array(); 
$this->data['export_csv'] = $this->url->link('catalog/product/exportCSV', 'token=' . $this->session->data['token'] . $url, 'SSL'); 

The controller simply resolves the export URL to the view so that it can be linked with the button.

1.2 View

1. Navigate to (your opencart store directory)/admin/view/template/catalog/product_list.tpl.
2. Found HTML: <div class="buttons">. <li>Add export button HTML: </li> <pre class='brush:php;toolbar:false;'>&lt;a onclick=&quot;location = '&lt;?php echo $export_csv; ?&gt;'&quot; class=&quot;button&quot;&gt;Export CSV&lt;/a&gt; </pre> <p> Go to your store's admin panel and select <strong> Catalog > Products </strong>, you will see the <strong>Export</strong> button as shown in the screenshot below. </p> <p><img src="/static/imghwm/default1.png" data-src="https://img.php.cn/upload/article/000/465/014/169358168749638.png?x-oss-process=image/resize,p_40" class="lazy" alt="创建用于导出产品 CSV 文件的 OpenCart 工具"></p> <h3 id="Export-products">2. Export products</h3> <h4 id="Controller">2.1 Controller</h4> <ol> <li> Navigate to <code class="inline"> (your opencart store directory)/admin/controller/catalog/product..
3. Create a new public function, namely public function exportCSV(){ }.
4. Inside the function, just add the following lines of code.

$this->load->model('catalog/product'); // Loading the Model of Products

$temp_data = $this->model_catalog_product->getProducts(array('filter_status'=>1)); // Fetch all the Products where Status is Enabled

/* CSV Header Starts Here */

header("Content-Type: text/csv");
header("Content-Disposition: attachment; filename=ProductsCSV-".date('d-m-Y').".csv");
// Disable caching
header("Cache-Control: no-cache, no-store, must-revalidate"); // HTTP 1.1
header("Pragma: no-cache"); // HTTP 1.0
header("Expires: 0"); // Proxies

/* CSV Header Ends Here */

$output = fopen("php://output", "w"); //Opens and clears the contents of file; or creates a new file if it doesn't exist

$data = array(); 

// We don't want to export all the information to be exported so maintain a separate array for the information to be exported
foreach($temp_data as $data)
{
    $data[] = array(
    'product_id' =>$data['product_id'],
    'model' =>$data['model'],
    'name' =>$data['name'],
    'quantity' =>$data['quantity'],
    
    );

}

// Exporting the CSV
foreach($data as $row)
{
    fputcsv($output, $row); // here you can change delimiter/enclosure
}

fclose($output); // Closing the File

for you! You created a product export tool for your OpenCart panel. Just click the export button and the CSV file will download to your computer. You can add as many columns as you need.

in conclusion

“Time is gold.” As an entrepreneur or business owner, you don’t want to waste your precious time. When it comes to software, entrepreneurs are always looking for the best, most efficient way to get the job done.

So, in this tutorial, we created a business tool that helps export product information from OpenCart in a faster and easier way using CSV data format. I will also write a tutorial on "CSV Import" so that we can easily add and update information as per our requirements.

I hope you found this article helpful for your business. Please give your valuable feedback below. Thanks!