<?xml version="1.0"?><phpdoc><class name="Bs_File" extends="Bs_FileSystem" undoc="false" access="private" package="file"><file>C:/usr/local/lib/php/blueshoes-4.2/core/file/Bs_File.class.php</file><doc><author>andrej arn &amp;lt;andrej at blueshoes dot org&amp;gt;</author><author>sam blume &amp;lt;sam at blueshoes dot org&amp;gt;</author><inherited src="Array"/><overriden src="Array"/><description>Class File is an Object representation of a file OR directory.NOTE I : A directory is to be seen as a file; a special file, but still, a file.NOTE II: Some successful test were made on Windows(c) 2000 and it seams as ifbackslashes &amp;apos;\&amp;apos; in the path work as well as UNIX like forslashes &amp;apos;/&amp;apos;.ERGO: Use forslashes &amp;apos;/&amp;apos;. Because it then will work on both systems and &amp;apos;\&amp;apos; could beeasily misinterpreted as escape char.&amp;gt;&amp;gt; YES, windows will always understand &amp;apos;/&amp;apos; while unix doesn&amp;apos;t accept &amp;apos;\&amp;apos;. --andrej</description><shortdescription>Represents a FILE (or a DIRECTORY?) as an Object</shortdescription><version>4.0-$id$</version><copyright>blueshoes.org</copyright></doc><function name="Bs_File" undoc="false" access="public"><doc><parameter name="$fullPath" default="&amp;apos;&amp;apos;" type="string">. A valid path to a file or dir.</parameter><return type="void"/><description>Fullpath may be of any format. E.g. dir, dir/, dir/file, ./dir/dir/file, ...NOTE: $fullPath should be a valid path to a file or dir. It will otherwise be &amp;apos;&amp;apos;.</description><shortdescription>Constructor.</shortdescription></doc></function><function name="cp" undoc="false" access="public"><doc><return type="void"/><description>overloading used here, for details check _cp2() and _cp3().</description><shortdescription>Copy the current file.</shortdescription></doc></function><function name="_cp2" undoc="false" access="private"><doc><parameter name="&amp;$newFullPath" type="string"/><parameter name="$returnType" default="&amp;apos;bool&amp;apos;" type="string">can be &amp;apos;bool&amp;apos; or &amp;apos;object&amp;apos;. bool: true=success|false=failure object: new instance of Bs_File on success, exception on failure.</parameter><return name="" type="mixed"> (boolean or object depending on $returnType)</return><throws>mixed (false or exception depending on $returnType)</throws><description>this is an overloaded method for cp()</description><shortdescription>Copy the current file to $newFullPath.</shortdescription></doc></function><function name="_cp3" undoc="false" access="private"><doc><parameter name="&amp;$newFileName" type="string"/><parameter name="$newPath" default="NULL," type="string"/><parameter name="$returnType" default="&amp;apos;bool&amp;apos;" type="string">can be &amp;apos;bool&amp;apos; or &amp;apos;object&amp;apos;. bool: true=success|false=failure object: new instance of Bs_File on success, exception on failure.</parameter><return name="" type="mixed"> (boolean or object depending on $returnType)</return><throws>mixed (false or exception depending on $returnType)</throws><description>this is an overloaded method for cp()if $newPath is null, the new file gets placed into the same dir as the current one.</description><shortdescription>Copy the current file to {$newPath}{$newFileName}</shortdescription></doc></function><function name="rm" undoc="false" access="public"><doc><return name="" type="bool"/><description>please don&amp;apos;t add synonyms like remove(), delete(), unlink() etc.</description><shortdescription>removes this file (rm).</shortdescription></doc></function><function name="readAll" undoc="false" access="public"><doc><parameter name="$fullPath" default="NULL" type="string">default is NULL. if used, this method is used static.</parameter><return name="" type="string">the whole file content.</return><throws>FALSE</throws><description/><shortdescription>reads everything from the file and returns it.</shortdescription></doc></function><function name="onewayWrite" undoc="false" access="public"><doc><see type="function">onewayAppend()</see><see type="function">exclusiveWrite()</see><parameter name="$string" type="string">the data you want to write to the file.</parameter><parameter name="$fullPath" default="NULL" type="string">default is NULL. if used, this method is used static.</parameter><return name="" type="bool">true on success, false on failure.</return><description>if it doesn&amp;apos;t exist it will be created.it&amp;apos;s called oneway because the file is opened, the string is written, and then the fileis closed immediatly.</description><shortdescription>writes $string to the file. if the file already exists all content will be overwritten.</shortdescription></doc></function><function name="onewayAppend" undoc="false" access="public"><doc><see type="function">onewayWrite()</see><see type="function">exclusiveWrite()</see><parameter name="$string" type="string">the data you want to write to the file.</parameter><parameter name="$fullPath" default="NULL" type="string">default is NULL. if used, this method is used static.</parameter><return name="" type="bool">true on success, false on failure.</return><description>if it doesn&amp;apos;t exist it will be created.it&amp;apos;s called oneway because the file is opened, the string is written, and then the fileis closed immediatly.</description><shortdescription>appends $string at the end of the file.</shortdescription></doc></function><function name="_write" undoc="false" access="private"><doc><see type="function">onewayWrite()</see><see type="function">onewayAppend()</see><parameter name="$string" type="string"/><parameter name="$fullPath" type="string"/><parameter name="$mode" type="string">(see http://www.php.net/manual/en/function.fopen.php)</parameter><return type="void"/><description/><shortdescription>internal write method.</shortdescription></doc></function><function name="exclusiveWrite" undoc="false" access="public"><doc><see type="function">onewayWrite()</see><see type="function">onewayAppend()</see><parameter name="$string" type="string">the data you want to write to the file.</parameter><parameter name="$fullPath" type="string">default is NULL. if used, this method is used static.</parameter><return name="" type="bool">TRUE on success, FALSE on failure (see getLastError()).</return><description>Try to get hold of a file exclusively and overwrite it with the passed data.</description><shortdescription>Exclusive file write.</shortdescription></doc></function><function name="write" undoc="false" access="private"><doc><see type="function">onewayWrite()</see><see type="function">append()</see><see type="function">onewayAppend()</see><parameter name="$string" undoc="true"/><return type="void"/><description/><shortdescription/></doc></function><function name="toString" undoc="true" access="public"><doc><parameter name="$cr" type="string" undoc="true"/><return name="" type="string"/><overriden src="Bs_Object"/><description/><shortdescription>Dump file attributes as String</shortdescription></doc></function><function name="toHtml" undoc="true" access="public"><doc><see type="function">toString()</see><return type="void"/><overriden src="Bs_Object"/><description/><shortdescription>Dump file attributes as HTML String</shortdescription></doc></function><function name="getLastError" undoc="false" access="public"><doc><see type="var">$_lastErrMsg</see><return name="" type="string"/><description/><shortdescription>returns the last occured error message.</shortdescription></doc></function><function name="mv" undoc="true" access="private"><doc><return type="void"/></doc></function><function name="create" undoc="true" access="private"><doc><parameter name="$fullPath" undoc="true"/><return type="void"/></doc></function><function name="append" undoc="true" access="private"><doc><parameter name="$string" undoc="true"/><return type="void"/></doc></function><variable name="$_lastErrMsg" access="private" type="string">&amp;apos;&amp;apos;<doc><see type="function">getLastError()</see><description/><shortdescription>holds the last occured error message.</shortdescription></doc></variable><constant name="BS_FILE_VERSION" undoc="true" access="private" case="default: case sensitive">4.0.$x$<doc></doc></constant><inherited src="Bs_FileSystem" type="functions"><element>bs_filesystem</element><element>getfileattr</element><element>standardizepath</element><element>getcwd</element><element>getrealpath</element><element>realpath</element><element>getrealpathsplit</element><element>realpathsplit</element><element>setfullpath</element><element>getfullpath</element><element>getpathstem</element><element>getfilename</element><element>getfileextension</element><element>basename</element><element>isvalidfilename</element><element>isvalidpath</element><element>isvalidfullpath</element><element>islink</element><element>clearstatcache</element><element>move</element></inherited><inherited src="Bs_Object" type="functions"><element>isex</element><element>isexception</element><element>persist</element><element>unpersist</element><element>bs_object</element><element>bbsetoutput</element><element>bbawake</element><element>bbisawake</element><element>bbxmsg</element><element>bbxfunctionstart</element><element>bbxfunctionend</element><element>bbxecho</element><element>bbxvar</element><element>bbxvardump</element><element>bbforcetrace</element><element>bbbufferstart</element><element>bbbufferget</element><element>bbbufferendflush</element><element>bbbufferendclean</element></inherited><inherited src="Bs_FileSystem" type="variables"><element>$_lastfetchedpath</element><element>$_bs_system</element><element>$_fullpath</element><element>$_lastfetchedfileattr</element></inherited><inherited src="Bs_FileSystem" type="consts"><element>bs_filesystem_version</element></inherited><inherited src="Bs_Object" type="consts"><element>bs_object_version</element></inherited><path><parent>Bs_FileSystem</parent><parent>Bs_Object</parent></path><baseclass>Bs_Object</baseclass></class></phpdoc>