Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 375d9bac3453e309900b475cb4a1efb836f97440 / . / user_guide / helpers / download_helper.html
blob: dd644e540eeafddbbe3c77c6276d58ef7aa21033 [file] [log] [blame]
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Download Helper</title>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
10<script type="text/javascript" src="../nav/nav.js"></script>
11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40
41<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
42<tr>
43<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]44<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]45<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
46Download Helper
47</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]48<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]49</tr>
50</table>
51<!-- END BREADCRUMB -->
52
53<br clear="all" />
54
55
56<!-- START CONTENT -->
57<div id="content">
58
59
60<h1>Download Helper</h1>
61
admin3cad41e2006-10-02 03:21:46 +0000[diff] [blame]62<p>The Download Helper lets you download data to your desktop.</p>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]63
64
65<h2>Loading this Helper</h2>
66
67<p>This helper is loaded using the following code:</p>
68<code>$this->load->helper('download');</code>
69
70<p>The following functions are available:</p>
71
72<h2>force_download('<var>filename</var>', '<var>data</var>')</h2>
73
admine334c472006-10-21 19:44:22 +0000[diff] [blame]74<p>Generates server headers which force data to be downloaded to your desktop. Useful with file downloads.
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]75The first parameter is the <strong>name you want the downloaded file to be named</strong>, the second parameter is the file data.
76Example:</p>
77
78<code>
79$data = 'Here is some text!';<br />
80$name = 'mytext.txt';<br />
81<br />
82force_download($name, $data);
83</code>
84
85<p>If you want to download an existing file from your server you'll need to read the file into a string:</p>
86
87<code>
88$data = file_get_contents("/path/to/photo.jpg"); // Read the file's contents<br />
89$name = 'myphoto.jpg';<br />
90<br />
91force_download($name, $data);
92</code>
93
94
95
96
97</div>
98<!-- END CONTENT -->
99
100
101<div id="footer">
102<p>
103Previous Topic:&nbsp;&nbsp;<a href="directory_helper.html">Directory Helper</a>
104&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
105<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
106<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
107Next Topic:&nbsp;&nbsp;<a href="file_helper.html">File Helper</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]108</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]109<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminc167f2c2006-10-02 02:47:59 +0000[diff] [blame]110</div>
111
112</body>
113</html>