user_guide/helpers/download_helper.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Download Helper : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  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='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  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_darker.jpg" width="154" height="43" 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>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  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">
  44 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  45 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  46 Download Helper
  47 </td>
  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>
  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
  62 <p>The Download Helper lets you download data to your desktop.</p>
  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
  74 <p>Generates server headers which force data to be downloaded to your desktop. Useful with file downloads.
  75 The first parameter is the <strong>name you want the downloaded file to be named</strong>, the second parameter is the file data.
  76 Example:</p>
  77
  78 <code>
  79 $data = 'Here is some text!';<br />
  80 $name = 'mytext.txt';<br />
  81 <br />
  82 force_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 />
  91 force_download($name, $data);
  92 </code>
  93
  94
  95
  96
  97 </div>
  98 <!-- END CONTENT -->
  99
 100
 101 <div id="footer">
 102 <p>
 103 Previous 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;
 107 Next Topic:&nbsp;&nbsp;<a href="email_helper.html">Email Helper</a></p>
 108 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 109 </div>
 110
 111 </body>
 112 </html>