API:EPrints/Filesys

From EPrints Documentation
Revision as of 18:29, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Filesys - virtual file system for EPrints

METHODS

login

 $filesys->login( USERNAME, PASSWORD [, BECOME ] )

Log in using USERNAME and PASSWORD.

cwd

 $cwd = $filesys->cwd( [ CWD ] )

Returns the current working directory.

chmod

 $filesys->chmod

Unimplemented.

modtime

 $filesys->modtime

Unimplemented.

size

 $filesys->size

Unimplemented.

delete

 $filesys->delete( PATH )

Delete the filename identified by CWD + PATH.

chdir

 $filename->chdir( PATH )

Change the working path to PATH.

mkdir

 $filesys->mkdir

Unimplemented.

rmdir

 $filesys->rmdir( PATH )

Like delete but can also be used with directories.

list

 $filesys->list( [ PATH ] )

List items contained in CWD + PATH.

list_details

 $filesys->list_details( [ PATH ] )

List items contained in CWD + PATH, with full detail.

stat

 $filesys->stat

Unimplemented.

test

 $filesys->test

Unimplemented.

open_read

 $filesys->open_read( PATH, [ opts? ] )

Open a file for reading, returns a file handle.

close_read

 $filesys->close_read( fh )

open_write

 $filesys->open_write( PATH [, APPEND ] )

Returns a file handle to write to.

close_write

 $filesys->close_write( fh )

seek

 $filesys->seek

Unimplemented.

utime

 $filesys->utime

Unimplemented

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

check_document

check_eprint

check_file

delete_document

delete_eprint

delete_file

get_object_mtime

list_document_contents

list_documents

list_inbox_eprints

new

open_file

write_new_document

write_new_eprint

write_new_file