Sophie

Sophie

distrib > Mandriva > 9.1 > ppc > media > main > by-pkgid > 0afeee9cca140e167a996902b9a677c5 > files > 652

php-manual-en-4.3.0-2mdk.noarch.rpm

<HTML
><HEAD
><TITLE
>file</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Filesystem functions"
HREF="ref.filesystem.html"><LINK
REL="PREVIOUS"
TITLE="file_get_contents"
HREF="function.file-get-contents.html"><LINK
REL="NEXT"
TITLE="fileatime"
HREF="function.fileatime.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.file-get-contents.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.fileatime.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.file"
></A
>file</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN25548"
></A
><P
>    (PHP 3, PHP 4 )</P
>file&nbsp;--&nbsp;Reads entire file into an array</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN25551"
></A
><H2
>Description</H2
>array <B
CLASS="methodname"
>file</B
> ( string filename [, int use_include_path])<BR
></BR
><P
> 
     Identical to <A
HREF="function.readfile.html"
><B
CLASS="function"
>readfile()</B
></A
>, except that
     <B
CLASS="function"
>file()</B
> returns the file in an array. Each
     element of the array corresponds to a line in the file, with the
     newline still attached.  Upon failure, <B
CLASS="function"
>file()</B
>
     returns <TT
CLASS="constant"
><B
>FALSE</B
></TT
>.
    </P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
      Each line in the resulting array will include the line ending, so you
      still need to use <A
HREF="function.trim.html"
><B
CLASS="function"
>trim()</B
></A
> if you do not want the line
      ending present.
     </P
></BLOCKQUOTE
></DIV
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>If you are having problems
with <TT
CLASS="literal"
>PHP</TT
> not recognizing the line endings when
reading files either on or created by a Macintosh computer, you
might want to enable the <A
HREF="ref.filesystem.html#ini.auto-detect-line-endings"
>auto_detect_line_endings</A
> run-time configuration option.</P
></BLOCKQUOTE
></DIV
><P
>&#13;     You can use the optional <TT
CLASS="parameter"
><I
>use_include_path</I
></TT
> parameter 
     and set it to "1", if you want to search for the file in the <A
HREF="configuration.directives.html#ini.include-path"
>include_path</A
>, too.
    </P
><P
>&#13;     <DIV
CLASS="informalexample"
><A
NAME="AEN25578"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>&#60;?php
// Get a file into an array.  In this example we'll go through HTTP to get 
// the HTML source of a URL.
$lines = file ('http://www.example.com/');

// Loop through our array, show html source as html source; and line numbers too.
foreach ($lines as $line_num =&#62; $line) {
    echo "Line #&#60;b&#62;{$line_num}&#60;/b&#62; : " . htmlspecialchars($line) . "&#60;br&#62;\n";
}

// Another example, let's get a web page into a string.  See also file_get_contents().
$html = implode ('', file ('http://www.example.com/'));
?&#62;</PRE
></TD
></TR
></TABLE
><P
></P
></DIV
>
    </P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
      As of PHP 4.3.0 you can use <A
HREF="function.file-get-contents.html"
><B
CLASS="function"
>file_get_contents()</B
></A
> to
      return the contents of a file as a string. 
     </P
><P
>&#13;      In PHP 4.3.0 <B
CLASS="function"
>file()</B
> became binary safe.
     </P
></BLOCKQUOTE
></DIV
><DIV
CLASS="tip"
><BLOCKQUOTE
CLASS="tip"
><P
><B
>Tip: </B
>You can use a URL as a
filename with this function if the <A
HREF="ref.filesystem.html#ini.allow-url-fopen"
>fopen wrappers</A
> have been enabled.
See <A
HREF="function.fopen.html"
><B
CLASS="function"
>fopen()</B
></A
> for more details on how to specify
the filename and <A
HREF="wrappers.html"
>Appendix I</A
> for a list of supported
URL protocols.</P
></BLOCKQUOTE
></DIV
><P
> 
     See also <A
HREF="function.readfile.html"
><B
CLASS="function"
>readfile()</B
></A
>,
     <A
HREF="function.fopen.html"
><B
CLASS="function"
>fopen()</B
></A
>, <A
HREF="function.fsockopen.html"
><B
CLASS="function"
>fsockopen()</B
></A
>, 
     <A
HREF="function.popen.html"
><B
CLASS="function"
>popen()</B
></A
>, <A
HREF="function.file-get-contents.html"
><B
CLASS="function"
>file_get_contents()</B
></A
>,
     and <A
HREF="function.include.html"
><B
CLASS="function"
>include()</B
></A
>.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.file-get-contents.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.fileatime.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>file_get_contents</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.filesystem.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>fileatime</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>