<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> <!--NewPage--> <HTML> <HEAD> <!-- Generated by PhpDoc date: 'Mon, 11 Nov 2002 23:46:30 +0100' --> <TITLE>Docs for page file.inc.php</TITLE> <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> </HEAD> <BODY BGCOLOR='white'> <h2>Page: Program_Root/file.inc.php</h2> <!-- ========== Info from phpDoc block ========= --> <b></b> <pre> </pre> <UL> <LI><b>Package</b> - <CODE>io</CODE></LI> </UL> <br> Classes defined on this page: <a href="../io/File.html">File</a><br> <!-- =========== CONSTANT SUMMARY =========== --> <A NAME='constant_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Include Statements Summary</B></FONT> </TD> </TR> </TABLE> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <THEAD> <TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> </THEAD> <TBODY> </TBODY> </TABLE> <br> <br> <!-- =========== CONSTANT SUMMARY =========== --> <A NAME='global_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Global Variable Summary</B></FONT> </TD> </TR> </TABLE> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <THEAD> <TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> </THEAD> <TBODY> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD><A HREF='_file_inc_php.html#%24file_sortField'>$file_sortField</A></TD> <TD>"name"</TD> <TD>The sorting field used during file sorting operations.</TD> </TR> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD><A HREF='_file_inc_php.html#%24file_sortOrder'>$file_sortOrder</A></TD> <TD>"asc"</TD> <TD>The sort order used during file sorting operations.</TD> </TR> </TBODY> </TABLE> <br> <br> <!-- =========== CONSTANT SUMMARY =========== --> <A NAME='constant_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Constant Summary</B></FONT> </TD> </TR> </TABLE> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <THEAD> <TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> </THEAD> <TBODY> </TBODY> </TABLE> <br> <br> <!-- =========== Function SUMMARY =========== --> <A NAME='Function_summary'><!-- --></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Function Summary</B></FONT> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='_file_inc_php.html#file_cmp'>int file_cmp ( $obj1, $obj2 )</A></B></CODE> <BR> <blockquote> Performs files comparison. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='_file_inc_php.html#file_getMime'>array file_getMime ( $filename )</A></B></CODE> <BR> <blockquote> Retrieves the file MIME media type and sub type. </blockquote> </TD> </TR> <!-- =========== Summary =========== --> <TR BGCOLOR='white' CLASS='TableRowColor'> <TD> <CODE><B><A HREF='_file_inc_php.html#file_highlight'>string file_highlight ( $filename )</A></B></CODE> <BR> <blockquote> Syntax highlighting of a file. </blockquote> </TD> </TR> </TABLE> <br> <!-- ============ CONSTANT DETAIL =========== --> <A NAME='constant_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Include Statements Detail</B></FONT> </TD> </TR> </TABLE> <br> <!-- ============ CONSTANT DETAIL =========== --> <A NAME='global_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Global Variable Detail</B></FONT> </TD> </TR> </TABLE> <A NAME='%24file_sortField'><!-- --></A><H3>$file_sortField</H3> <P><B>$file_sortField = ->"name"<-</B></P> <!-- ========== Info from phpDoc block ========= --> <b>The sorting field used during file sorting operations.</b> <pre> This variable shouldn't be modified. It is used internally by <a href="../io/Dir.html#read">Dir::read()</a>, <a href="../io/Dir.html#readFiles">Dir::readFiles()</a> methods. Files can be sorted according to its names, size and modification date. </pre> <UL> </UL> <HR> <A NAME='%24file_sortOrder'><!-- --></A><H3>$file_sortOrder</H3> <P><B>$file_sortOrder = ->"asc"<-</B></P> <!-- ========== Info from phpDoc block ========= --> <b>The sort order used during file sorting operations.</b> <pre> This variable shouldn't be modified. It is used internally by <a href="../io/Dir.html#read">Dir::read()</a>, <a href="../io/Dir.html#readFiles">Dir::readFiles()</a> methods. </pre> <UL> </UL> <HR> <br> <!-- ============ CONSTANT DETAIL =========== --> <A NAME='constant_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Constant Detail</B></FONT> </TD> </TR> </TABLE> <br> <!-- ============ FUNCTION DETAIL =========== --> <A NAME='function_detail'></A> <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'> <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> <TD> <FONT SIZE='+2'><B>Function Detail</B></FONT> </TD> </TR> </TABLE> <A NAME='file_cmp'><!-- --></A><H3>file_cmp</H3> <P><B>int file_cmp ( $obj1, $obj2 )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Performs files comparison.</b> <pre> This function is used internally by <a href="../io/Dir.html#read">Dir::read()</a>, <a href="../io/Dir.html#readFiles">Dir::readFiles()</a> methods and it shouldn't be used outside these methods. Returns < 0 if $obj1->_root is less than $obj2->_root; > 0 if $obj1->_root is greater than $obj2->_root, and 0 if they are equal. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $obj1</i>: the File object.</CODE></DD> <DD><CODE>- <i>string $obj2</i>: the File object.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>private</CODE></DD> <DD><b>Author</b> - <CODE>Robert Bala <<a href="mailto:hide@address.com">hide@address.com</a>></CODE></DD> </DL> <HR> <A NAME='file_getMime'><!-- --></A><H3>file_getMime</H3> <P><B>array file_getMime ( $filename )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Retrieves the file MIME media type and sub type.</b> <pre> Returns the array containing MIME media type and sub type according to file extension. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $filename</i>: the file name.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> <DD><b>Author</b> - <CODE>Robert Bala <<a href="mailto:hide@address.com">hide@address.com</a>></CODE></DD> </DL> <HR> <A NAME='file_highlight'><!-- --></A><H3>file_highlight</H3> <P><B>string file_highlight ( $filename )</B></P> <P></P> <!-- ========== Info from phpDoc block ========= --> <b>Syntax highlighting of a file.</b> <pre> Returns a syntax higlighted version of the code contained in file using the colors defined in the built-in syntax highlighter for PHP. If the file could not be readed the empty string is returned. </pre> <DL> <DT>Function Parameters:</DT> <DD><CODE>- <i>string $filename</i>: the file name.</CODE></DD> <DT>Function Info:</DT> <DD><b>Access</b> - <CODE>public</CODE></DD> <DD><b>Author</b> - <CODE>Robert Bala <<a href="mailto:hide@address.com">hide@address.com</a>></CODE></DD> </DL> <HR> <br> </HTML>