API:EPrints/VFS

From EPrints Documentation
Revision as of 18:29, 11 August 2009 by Tdb01r (talk | contribs) (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. -...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Directory Operations

vfs_chdir

 $child = $vfs->vfs_chdir( ID )

Return the child directory called ID, or undef if it doesn't exist.

vfs_mkdir

 $ok = $vfs->vfs_mkdir( ID )

Make a child directory called ID.

vfs_rmdir

 $ok = $vfs->vfs_rmdir( ID )

Remove a child directory called ID.


Listings

vfs_list

 $ok = $vfs->vfs_list(sub { ID })

Return a list of ids of objects we hold.

vfs_list_details

 $ok = $vfs->vfs_list_details(sub { DETAIL })

Return a detailed list of our children and objects.


Object Operations

vfs_read

 $ok = $vfs->vfs_read(ID, sub { BUFFER })

Reads the content stored at ID.

vfs_write

 $ok = $vfs->vfs_write(ID, CONTENT_LENGTH, BUFFER = sub {})

Writes the content returned by sub{} to ID.

vfs_delete

 $ok = $vfs->vfs_delete( ID )

Remove an object called ID.

vfs_size

 $bytes = $vfs->vfs_size( ID )

Return the size in bytes of ID, or undef if it doesn't exist.