API:EPrints/Plugin/Storage - Revision history

https://wiki.eprints.org/w/index.php?action=history&feed=atom&title=API%3AEPrints%2FPlugin%2FStorage API:EPrints/Plugin/Storage - Revision history 2026-05-04T04:53:08Z Revision history for this page on the wiki MediaWiki 1.31.8 https://wiki.eprints.org/w/index.php?title=API:EPrints/Plugin/Storage&diff=10822&oldid=prev Tdb01r at 13:47, 25 July 2013 2013-07-25T13:47:03Z

<p></p> <table class="diff diff-contentalign-left" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en-GB"> <td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 13:47, 25 July 2013</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l26" >Line 26:</td> <td colspan="2" class="diff-lineno">Line 26:</td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>==DESCRIPTION==</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>==DESCRIPTION==</div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>See [[API:EPrints/Storage|EPrints::Storage]] for information on using the storage layer.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>See [[API:EPrints/Storage|EPrints::Storage]] for information on using the storage layer.</div></td></tr> <tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr> <tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">You shouldn't need to use a storage plugin directly.</ins></div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div></div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div></div></td></tr> <tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l58" >Line 58:</td> <td colspan="2" class="diff-lineno">Line 60:</td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>CALLBACK = $rc = &amp;f( BYTES )</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>CALLBACK = $rc = &amp;f( BYTES )</div></td></tr> <tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr> <tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">Note: this API may change in future to reflect the open_write/write/close_write mechanism.</ins></div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div></div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div></div></td></tr> </table>

Tdb01r https://wiki.eprints.org/w/index.php?title=API:EPrints/Plugin/Storage&diff=10821&oldid=prev Tdb01r: Created page with '<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' com…' 2013-07-25T13:42:41Z

<p>Created page with '{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Plugin/Storage.pm|package_name=EPrints::Plugin::Storage}}[[Category:API|STORAGE]][[Category:API:EPrints/Plugin|STORAGE]][[Category:API:EPrints/Plugin/Storage|STORAGE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Plugin::Storage<br /> <br /> <br /> <br /> <br /> <br /> <br /> ==SYNOPSIS==<br /> <source lang="perl">$plugin = $repo->plugin('Storage::Local');<br /> $plugin->open_write($fileobj) or die;<br /> $plugin->write('Hello, World!');<br /> $plugin->close_write() or die;</source><br /> <br /> <br /> <br /> <br /> <br /> <br /> ==DESCRIPTION==<br /> See [[API:EPrints/Storage|EPrints::Storage]] for information on using the storage layer.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ==METHODS==<br /> <br /> ===store===<br /> <br /> <source lang="perl">$sourceid = $store->store( $fileobj, CALLBACK )<br /> <br /> </source><br /> Store an object using data from CALLBACK.<br /> <br /> If successful returns the source id used to retrieve this object.<br /> <br /> Returns undef on error.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===retrieve===<br /> <br /> <source lang="perl">$success = $store->retrieve( $fileobj, $sourceid, $offset, $len, CALLBACK )<br /> <br /> </source><br /> Retrieve $n bytes of data starting at $offset from the data stored for $fileobj identified by $sourceid.<br /> <br /> CALLBACK = $rc = &amp;f( BYTES )<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===delete===<br /> <br /> <source lang="perl">$success = $store->delete( $fileobj, $sourceid )<br /> <br /> </source><br /> Delete the object stored for $fileobj.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===get_local_copy===<br /> <br /> <source lang="perl">$filename = $store->get_local_copy( $fileobj, $sourceid )<br /> <br /> </source><br /> Return the name of a local copy of the file (may be a {{API:PodLink|file=File/Temp|package_name=File::Temp|section=|text=File::Temp}} object).<br /> <br /> Returns undef if no local copy is available.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===get_remote_copy===<br /> <br /> <source lang="perl">$url = $store->get_remote_copy( $fileobj, $sourceid )<br /> <br /> </source><br /> Returns an alternative URL for this file (must be publicly accessible).<br /> <br /> Returns undef if no such copy is available.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===open_write===<br /> <br /> <source lang="perl">$ok = $store->open_write( $fileobj )<br /> <br /> </source><br /> Initialise a new write based on $fileobj.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===write===<br /> <br /> <source lang="perl">$ok = $store->write( $fileobj, $buffer )<br /> <br /> </source><br /> Write $buffer. Will croak if $fileobj was not previously opened for writing with open_write().<br /> <br /> <br /> <br /> <br /> <br /> <br /> ===close_write===<br /> <br /> <source lang="perl">$sourceid = $store->close_write( $fileobj )<br /> <br /> </source><br /> Finish writing to $fileobj. Returns the sourceid or undef on failure.<br /> <br /> <br /> <br /> <br /> <br /> <br /> ==COPYRIGHT==<br /> Copyright 2000-2011 University of Southampton.<br /> <br /> This file is part of EPrints http://www.eprints.org/.<br /> <br /> EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<br /> <br /> EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.<br /> <br /> You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.<br /> <br /> <br /> <br /> <br /> <br /> <br /> </div>

Tdb01r