Difference between revisions of "API:EPrints/Filesys"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/Filesys.pm|package_name=EPrints::Filesys}}[[Category:API|Filesys]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
'''EPrints::Filesys''' - virtual file system for EPrints
 
  
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_methods -->=METHODS=
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_login -->==login==
 
 
  $filesys-&gt;login( USERNAME, PASSWORD [, BECOME ] )
 
 
Log in using USERNAME and PASSWORD.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_cwd -->==cwd==
 
 
  $cwd = $filesys-&gt;cwd( [ CWD ] )
 
 
Returns the current working directory.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_chmod -->==chmod==
 
 
  $filesys-&gt;chmod
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_modtime -->==modtime==
 
 
  $filesys-&gt;modtime
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_size -->==size==
 
 
  $filesys-&gt;size
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_delete -->==delete==
 
 
  $filesys-&gt;delete( PATH )
 
 
Delete the filename identified by CWD + PATH.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_chdir -->==chdir==
 
 
  $filename-&gt;chdir( PATH )
 
 
Change the working path to PATH.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_mkdir -->==mkdir==
 
 
  $filesys-&gt;mkdir
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_rmdir -->==rmdir==
 
 
  $filesys-&gt;rmdir( PATH )
 
 
Like delete but can also be used with directories.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_list -->==list==
 
 
  $filesys-&gt;list( [ PATH ] )
 
 
List items contained in CWD + PATH.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_list_details -->==list_details==
 
 
  $filesys-&gt;list_details( [ PATH ] )
 
 
List items contained in CWD + PATH, with full detail.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_stat -->==stat==
 
 
  $filesys-&gt;stat
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_test -->==test==
 
 
  $filesys-&gt;test
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_open_read -->==open_read==
 
 
  $filesys-&gt;open_read( PATH, [ opts? ] )
 
 
Open a file for reading, returns a file handle.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_close_read -->==close_read==
 
 
  $filesys-&gt;close_read( fh )
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_open_write -->==open_write==
 
 
  $filesys-&gt;open_write( PATH [, APPEND ] )
 
 
Returns a file handle to write to.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_close_write -->==close_write==
 
 
  $filesys-&gt;close_write( fh )
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_seek -->==seek==
 
 
  $filesys-&gt;seek
 
 
Unimplemented.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_utime -->==utime==
 
 
  $filesys-&gt;utime
 
 
Unimplemented
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_check_document -->==check_document==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_check_eprint -->==check_eprint==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_check_file -->==check_file==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_delete_document -->==delete_document==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_delete_eprint -->==delete_eprint==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_delete_file -->==delete_file==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_object_mtime -->==get_object_mtime==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_list_document_contents -->==list_document_contents==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_list_documents -->==list_documents==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_list_inbox_eprints -->==list_inbox_eprints==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_new -->==new==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_open_file -->==open_file==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_write_new_document -->==write_new_document==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_write_new_eprint -->==write_new_eprint==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_write_new_file -->==write_new_file==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Revision as of 15:40, 12 August 2009