EPrints Documentation - User contributions [en-gb]

https://wiki.eprints.org/w/api.php?action=feedcontributions&feedformat=atom&user=Pod2wiki EPrints Documentation - User contributions [en-gb] 2026-04-22T13:20:55Z User contributions MediaWiki 1.31.8 https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Recaptcha&diff=16657 API:EPrints/MetaField/Recaptcha 2024-08-02T11:11:29Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Recaptcha.pm|package_name=EPrints::MetaField::Recaptcha}}[[Category:API|RECAPTCHA]][[Category:API:EPrints/MetaField|RECAPTCHA]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Recaptcha''' - a Captcha<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Please refer to the notes in <tt>EPRINTS_PATH/archives/[ARCHIVEID]/cfg/cfg.d/recaptcha.pl</tt>.<br /> <br /> If this files does not exist, copy [EPRINTS_ROOT]/lib/defaultcfg/cfg.d/recaptcha.pl.example to the path above and edit it.<br /> <br /> This field uses the Google "reCAPTCHA" service (https://www.google.com/recaptcha/intro/) and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).<br /> <br /> Note: This MetaField was updated in October 2017 to reCAPTCHA v2. The previous version of reCAPTCHA will cease to work in March 2018.<br /> <br /> Kudos to Matthew Kerwin (https://github.com/phluid61) for most of the work on the new version.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=Template:API:Copyright&diff=16656 Template:API:Copyright 2024-08-02T11:04:33Z

<p>Pod2wiki: </p> <hr /> <div>&copy; Copyright 2000-2024 University of Southampton. <br /> <br /> EPrints 3.4 is supplied by EPrints Services.<br /> <br /> http://www.eprints.org/eprints-3.4/<br /> <br /> === LICENSE ===<br /> This file is part of EPrints 3.4 http://www.eprints.org/.<br /> <br /> EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.<br /> <br /> EPrints 3.4 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 3.4. If not, see http://www.gnu.org/licenses/.</div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Recaptcha3&diff=16655 API:EPrints/MetaField/Recaptcha3 2024-08-02T11:02:35Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Recaptcha3.pm|package_name=EPrints::MetaField::Recaptcha3}}[[Category:API|RECAPTCHA3]][[Category:API:EPrints/MetaField|RECAPTCHA3]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Recaptcha3''' - a Captcha using Google ReCAPTCHA v3.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This metadata field renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).<br /> <br /> Please refer to the wiki page https://wiki.eprints.org/w/Recaptcha3_field for advice on how to configure settings required for this field to work.<br /> <br /> The following configuration settings will be required, where the <tt>CHANGME</tt> settings will need to be updated with the secret and site keys provided by Google:<br /> <br /> $c-&gt;{recaptcha3}-&gt;{private_key} = "CHANGEME";<br /> $c-&gt;{recaptcha3}-&gt;{public_key} = "CHANGEME";<br /> $c-&gt;{recaptcha3}-&gt;{min_score} = 0.5;<br /> <br /> This field uses version 3 of Google "reCAPTCHA" service:<br /> <br /> https://developers.google.com/recaptcha/docs/v3<br /> <br /> Please use the URL above for guidance on how to generate appropriate keys needed to configure this type of field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Recaptcha3&diff=16654 API:EPrints/MetaField/Recaptcha3 2024-08-02T11:01:45Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Recaptcha3.pm|package_name=EPrints::MetaField::Recaptcha3}}[[Category:API|RECAPTCHA3]][[Category:API:EPrints/MetaField|RECAPTCHA3]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Recaptcha3''' - a Captcha using Google ReCAPTCHA v3.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Please refer to the notes in [EPRINTS_ROOT]/archives/[ARCHIVEID]/cfg/cfg.d/recaptcha3.pl.<br /> <br /> If this files does not exist, copy [EPRINTS_ROOT]/lib/defaultcfg/cfg.d/recaptcha3.pl.example to the path above and edit it.<br /> <br /> This field uses version 3 of Google "reCAPTCHA" service:<br /> <br /> https://developers.google.com/recaptcha/docs/v3<br /> <br /> and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Plugin/Screen/SetLang&diff=16653 API:EPrints/Plugin/Screen/SetLang 2024-08-02T10:36:40Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Plugin/Screen/SetLang.pm|package_name=EPrints::Plugin::Screen::SetLang}}[[Category:API|SETLANG]][[Category:API:EPrints/Plugin/Screen|SETLANG]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Plugin::Screen::SetLang''' - Screen plugin for setting a cookie for the language to use on repository web pages.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This plugin allows a cookie called <tt>eprints_lang</tt> to set that specifies the language that be used for the current visitor to the repository. <br /> <br /> This takes the value of the <tt>lang</tt> attribute from the HTTP GET of the request (<tt>/cgi/set_lang</tt>) to set the cookie.<br /> <br /> Once the language is set the user is returned the page they original came from, which now should display in their preferred lanaguage.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===from===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;from<br /> Creates the <tt>eprints_lang</tt> cookie using the value of <tt>lang</tt> attribute from the HTTP GET of the request (<tt>/cgi/set_lang</tt>).<br /> <br /> Once the cookie is set the client is redirected back to their original page (specified by the <tt>Referrer</tt> header of the request or the repository homepage.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_action_link===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;render_action_link<br /> Returns a XHTML DOM fragment for a link or links to alternative languages that could be used on the repository, (including a link to clear the currently selected language). Once one of these links is clicked, the <tt>eprints_lang</tt> cookie will be updated appropriately.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;render<br /> Returns an XHTML DOM object that is a rendering of screen. As the client should be always be redirected from this page, once the <tt>eprints_lang</tt> cookie is updated, it just contain as message saying the redirect failed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Plugin/Screen/SetLang&diff=16652 API:EPrints/Plugin/Screen/SetLang 2024-08-02T10:29:00Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Plugin/Screen/SetLang.pm|package_name=EPrints::Plugin::Screen::SetLang}}[[Category:API|SETLANG]][[Category:API:EPrints/Plugin/Screen|SETLANG]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Plugin::Screen::SetLang''' - Screen plugin for setting a cookie for the language to use on repository web pages.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This plugin allows a cookie called <tt>eprints_lang</tt> to set that specify the language that be used for the current visitor to the repository. <br /> <br /> This takes the value of the <tt>lang</tt> attribute from the HTTP GET of the request (<tt>/cgi/set_lang</tt>) to set the cookie.<br /> <br /> Once the language is set the user is returned the page they original came from, which now should display in their preferred lanaguage.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===from===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;from<br /> Creates the <tt>eprints_lang</tt> cookie using the value of <tt>lang</tt> attribute from the HTTP GET of the request (<tt>/cgi/set_lang</tt>).<br /> <br /> Once the cookie is set the client is redirected back to their original page (specified by the <tt>Referrer</tt> header of the request or the repository homepage.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_action_link===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;render_action_link<br /> Returns a XHTML DOM fragment for a link or links to alternative languages that could be used on the repository, (including a link to clear the currently selected language). Once one of these links is clicked, the <tt>eprints_lang</tt> cookie will be updated appropriately.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render===<br /> <br /> EPrints::Plugin::Screen::SetLang-&gt;render<br /> Returns an XHTML DOM object that is a rendering of screen. As the client should be always be redirected from this page, once the <tt>eprints_lang</tt> cookie is updated, it just contain as message saying the redirect failed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15722 API:EPrints/MetaField/Base64 2023-03-20T17:13:26Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> '''EPrints::MetaField::Base64'''<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15721 API:EPrints/MetaField/Base64 2023-03-20T17:12:11Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> {{API:PodLink|file=EPrints/MetaField|package_name=EPrints::MetaField|section=|text=MetaField}}<br /> {{API:PodLink|file=EPrints/MetaField/Text|package_name=EPrints::MetaField::Text|section=|text=Text}}<br /> {{API:PodLink|file=EPrints/MetaField/Longtext|package_name=EPrints::MetaField::Longtext|section=|text=Longtext}}<br /> Base64<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15720 API:EPrints/MetaField/Base64 2023-03-20T17:11:21Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:MetaField|EPrints::MetaField]]<br /> [[API:Text|EPrints::MetaField::Text]]<br /> [[API:Longtext|EPrints::MetaField::Longtext]]<br /> Base64<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15719 API:EPrints/MetaField/Base64 2023-03-20T17:10:44Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> EPrints::MetaField::Base64<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15718 API:EPrints/MetaField/Base64 2023-03-20T17:10:27Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> EPrints::MetaField::Base64 =head1 PROPERTIES<br /> <br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15717 API:EPrints/MetaField/Base64 2023-03-20T17:10:11Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> EPrints::MetaField::Base64<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15716 API:EPrints/MetaField/Base64 2023-03-20T17:10:00Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> EPrints::MetaField::Base64<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15715 API:EPrints/MetaField/Base64 2023-03-20T17:09:32Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]<br /> [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]<br /> [[API:EPrints/MetaField/Base64|EPrints/MetaField/Base64]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15714 API:EPrints/MetaField/Base64 2023-03-20T17:05:43Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===[[API:EPrints/MetaField|EPrints::MetaField]]===<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===[[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]===<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===[[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]===<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===[[API:EPrints/MetaField/Base64|EPrints/MetaField/Base64]]===<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15713 API:EPrints/MetaField/Base64 2023-03-20T17:01:20Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES==<br /> <em>To be written</em><br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/MetaField/Base64&diff=15712 API:EPrints/MetaField/Base64 2023-03-20T17:00:28Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::MetaField::Base64''' - Base 64 encoded data<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==INHERITANCE==<br /> [[API:EPrints/MetaField|EPrints::MetaField]] =over 4 [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]] =over 4 [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]] =over 4 [[API:EPrints/MetaField/Base64|EPrints/MetaField/Base64]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==PROPERTIES<em>To be written</em>==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===form_value===<br /> <br /> $value = $field-&gt;form_value( $session, $object, [$prefix] )<br /> Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.<br /> <br /> Returns a single scalar or array of base64 encoded values.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===to_sax===<br /> <br /> $xml = $field-&gt;to_sax( $value, %opts )<br /> Print the field and value(s) as an XML representation of a base64 field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_xml_schema_type===<br /> <br /> $type = $field-&gt;get_xml_schema_type<br /> Gets the XML schema type for this base64 field.<br /> <br /> Returns a string containing the type, dataset ID and and name of this field (e.g. <tt>base64_file_data</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_xml_schema_type===<br /> <br /> $type = $field-&gt;render_xml_schema_type<br /> Produces an XML fragment this base64 field.<br /> <br /> Returns a DOM for the following:<br /> <br /> &lt;xs:complexType name="base64_file_data"&gt;<br /> &lt;xs:simpleContent&gt;<br /> &lt;xs:extension base="xs:base64Binary"&gt;<br /> &lt;xs:attribute name="encoding"&gt;<br /> &lt;xs:simpleType&gt;<br /> &lt;xs:restriction base="xs:string"&gt;<br /> &lt;xs:enumeration value="base64" /&gt;<br /> &lt;/xs:restriction&gt;<br /> &lt;/xs:simpleType&gt;<br /> &lt;/xs:attribute&gt;<br /> &lt;/xs:extension&gt;<br /> &lt;/xs:simpleContent&gt;<br /> &lt;/xs:complexType&gt;<br /> <br /> E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Citation/XSL&diff=15691 API:EPrints/Citation/XSL 2023-03-16T17:24:12Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Citation/XSL.pm|package_name=EPrints::Citation::XSL}}[[Category:API|XSL]][[Category:API:EPrints/Citation|XSL]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Citation::XSL''' - Loading and rendering of XSL based citation styles.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Loads XSL citation style files and renders citations for a particular type of data object.<br /> <br /> This class inherits from [[API:EPrints/Citation|EPrints::Citation]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===load_source===<br /> <br /> $citation-&gt;load_source<br /> Load XSL citation source from file.<br /> <br /> Returns 1 if citation source was successfully loaded.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render===<br /> <br /> $frag = $citation-&gt;render( $dataobj, %opts )<br /> Renders a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style.<br /> <br /> Returns a XML document fragment of the citation rendering.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===error===<br /> <br /> $citation-&gt;error( $type, $message )<br /> Add <tt>$message</tt> of <tt>$type</tt> to array of messages for this citation.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> [[API:EPrints/Citation|EPrints::Citation]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Citation/EPC&diff=15690 API:EPrints/Citation/EPC 2023-03-16T17:24:07Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Citation/EPC.pm|package_name=EPrints::Citation::EPC}}[[Category:API|EPC]][[Category:API:EPrints/Citation|EPC]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Citation::EPC''' - Loading and rendering of EPC XML based citation styles.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Loads EPC XML citation style files and renders citations for a particular type of data object.<br /> <br /> This class inherits from [[API:EPrints/Citation|EPrints::Citation]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===load_source===<br /> <br /> $citation-&gt;load_source<br /> Load EPC citation source from file.<br /> <br /> Returns 1 if citation source was successfully loaded.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render===<br /> <br /> $frag = $citation-&gt;render( $dataobj, %opts )<br /> Used to render a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style.<br /> <br /> Returns a XML document fragment of the citation rendering.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> [[API:EPrints/Citation|EPrints::Citation]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Citation/EPC&diff=15689 API:EPrints/Citation/EPC 2023-03-16T17:21:29Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Citation/EPC.pm|package_name=EPrints::Citation::EPC}}[[Category:API|EPC]][[Category:API:EPrints/Citation|EPC]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Citation::EPC''' - Loading and rendering of EPC XML based citation styles.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Loads EPC XML citation style files and renders citations for a particular type of data object.<br /> <br /> This class inherits from [[API:EPrints/Citation|EPrints::Citation]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===load_source===<br /> <br /> $citation-&gt;load_source<br /> Load EPC citation source from file.<br /> <br /> Returns 1 if citation source was successfully loaded.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render===<br /> <br /> $frag = $citation-&gt;render( $dataobj, %opts )<br /> Used to render a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style.<br /> <br /> Returns an XML document fragment of the citation rendering.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> [[API:EPrints/Citation|EPrints::Citation]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15687 API:bin/unit tests 2023-03-15T19:12:10Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Runs unit tests under ''tests/'' against a chosen EPrints repository.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the EPrints repository to run unit tests against.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Template&diff=15686 API:EPrints/Apache/Template 2023-03-15T17:25:18Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Template.pm|package_name=EPrints::Apache::Template}}[[Category:API|TEMPLATE]][[Category:API:EPrints/Apache|TEMPLATE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Template''' - Template Applying Module<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> When HTML pages are served by EPrints they are processed through a template written in XML. Most repositories will have two templates - ''default.xml'' for HTTP and ''secure.xml'' for HTTPS.<br /> <br /> Templates are parsed at '''server start-up''' and any included phrases are replaced at that point. Because templates persist over the lifetime of a server you do not typically perform any logic within the template itself, instead use a pin generated via [[API:EPrints/Apache/Template#Custom_Pins|Custom Pins]].<br /> <br /> The page content is added to the template via <tt>&lt;epc:pins</tt>&gt;.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Synopsis===<br /> &lt;?xml version="1.0" standalone="no"?&gt;<br /> &lt;!DOCTYPE html SYSTEM "entities.dtd"&gt;<br /> &lt;html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control"&gt;<br /> &lt;head&gt;<br /> &lt;title&gt;&lt;epc:pin ref="title" textonly="yes"/&gt; - &lt;epc:phrase ref="archive_name"/&gt;&lt;/title&gt;<br /> ...<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Custom Pins===<br /> In ''cfg.d/dynamic_template.pl'':<br /> <br /> $c-&gt;{dynamic_template}-&gt;{function} = sub {<br /> my( $repo, $parts ) = @_;<br /> <br /> $parts-&gt;{mypin} = $repo-&gt;xml-&gt;create_text_node( "Hello, World!" );<br /> };<br /> <br /> In ''archives/[archiveid]/cfg/templates/default.xml'' (copy from ''lib/templates/default.xml'' if not already exists):<br /> <br /> &lt;epc:pin ref="mypin" /&gt;<br /> <br /> Or, for just the text content of a pin:<br /> <br /> &lt;epc:pin ref="mypin" textonly="yes" /&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Default Pins===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====title====<br /> <br /> The title of the page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====page====<br /> <br /> The page content.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====login_status_header====<br /> <br /> HTML <tt>&lt;head</tt>&gt; includes for the login status of the user - currently just some JavaScript variables.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====head====<br /> <br /> Page-specific HTML <tt>&lt;head</tt>&gt; contents.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====pagetop====<br /> <br /> (Unused?)<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====login_status====<br /> <br /> A menu containing [[API:EPrints/Plugin/Screen|EPrints::Plugin::Screen]]s that appear in <tt>key_tools</tt>. The content from each plugin's <tt>render_action_link</tt> is rendered as a HTML <tt>&lt;ul</tt>&gt; list.<br /> <br /> Historically this was the login/logout links plus <tt>key_tools</tt> but since 3.3 login/logout are Screen plugins as well.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====languages====<br /> <br /> The <tt>render_action_link</tt> from [[API:EPrints/Plugin/Screen/SetLang|EPrints::Plugin::Screen::SetLang]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Template::handler( $r )<br /> Handler for applying site layout templates.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> The directories scanned for template sources are in [[API:EPrints/Repository#template_dirs|EPrints::Repository/template_dirs]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Template&diff=15685 API:EPrints/Apache/Template 2023-03-15T17:25:08Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Template.pm|package_name=EPrints::Apache::Template}}[[Category:API|TEMPLATE]][[Category:API:EPrints/Apache|TEMPLATE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Template''' - Template Applying Module<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> When HTML pages are served by EPrints they are processed through a template written in XML. Most repositories will have two templates - ''default.xml'' for HTTP and ''secure.xml'' for HTTPS.<br /> <br /> Templates are parsed at '''server start-up''' and any included phrases are replaced at that point. Because templates persist over the lifetime of a server you do not typically perform any logic within the template itself, instead use a pin generated via [[API:EPrints/Apache/Template#Custom_Pins|Custom Pins]].<br /> <br /> The page content is added to the template via <tt>&lt;epc:pins</tt>&gt;.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Synopsis===<br /> &lt;?xml version="1.0" standalone="no"?&gt;<br /> &lt;!DOCTYPE html SYSTEM "entities.dtd"&gt;<br /> &lt;html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control"&gt;<br /> &lt;head&gt;<br /> &lt;title&gt;&lt;epc:pin ref="title" textonly="yes"/&gt; - &lt;epc:phrase ref="archive_name"/&gt;&lt;/title&gt;<br /> ...<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Custom Pins===<br /> In ''cfg.d/dynamic_template.pl'':<br /> <br /> $c-&gt;{dynamic_template}-&gt;{function} = sub {<br /> my( $repo, $parts ) = @_;<br /> <br /> $parts-&gt;{mypin} = $repo-&gt;xml-&gt;create_text_node( "Hello, World!" );<br /> };<br /> <br /> In ''archives/[archiveid]/cfg/templates/default.xml'' (copy from ''lib/templates/default.xml'' if not already exists):<br /> <br /> &lt;epc:pin ref="mypin" /&gt;<br /> <br /> Or, for just the text content of a pin:<br /> <br /> &lt;epc:pin ref="mypin" textonly="yes" /&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Default Pins===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====title====<br /> <br /> The title of the page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====page====<br /> <br /> The page content.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====login_status_header====<br /> <br /> HTML <tt>&lt;head</tt>&gt; includes for the login status of the user - currently just some JavaScript variables.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====head====<br /> <br /> Page-specific HTML <tt>&lt;head</tt>&gt; contents.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====pagetop====<br /> <br /> (Unused?)<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====login_status====<br /> <br /> A menu containing [[API:EPrints/Plugin/Screen|EPrints::Plugin::Screen]]s that appear in <tt>key_tools</tt>. The content from each plugin's <tt>render_action_link</tt> is rendered as a HTML <tt>&lt;ul</tt>&gt; list.<br /> <br /> Historically this was the login/logout links plus <tt>key_tools</tt> but since 3.3 login/logout are Screen plugins as well.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====languages====<br /> <br /> The <tt>render_action_link</tt> from [[API:EPrints/Plugin/Screen/SetLang|EPrints::Plugin::Screen::SetLang]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Template::handler( $r )<br /> Handler for applying site layout templates.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> The directories scanned for template sources are in [[API:EPrints/Repository#template_dirs|EPrints::Repository/template_dirs]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHTCopyright 2023 University of Southampton. EPrints 3.4 is supplied by EPrints Services.<br /> <br /> http://www.eprints.org/eprints-3.4/<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHT<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Sword&diff=15684 API:EPrints/Apache/Sword 2023-03-15T17:20:35Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Sword.pm|package_name=EPrints::Apache::Sword}}[[Category:API|SWORD]][[Category:API:EPrints/Apache|SWORD]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Sword''' - Authenticates requests to EPrints' SWORD API.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Authenticates requests to EPrints' SWORD API returning a suitable HTTP response.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===authenticate===<br /> <br /> $response = EPrints::Apache::Sword::authenticate( $session, $request )<br /> Authenticates a SWORD request and returns suitable HTTP response.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> https://en.wikipedia.org/wiki/SWORD_(protocol)<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Storage&diff=15683 API:EPrints/Apache/Storage 2023-03-15T17:16:54Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Storage.pm|package_name=EPrints::Apache::Storage}}[[Category:API|STORAGE]][[Category:API:EPrints/Apache|STORAGE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Storage''' - deliver file objects via <tt>mod_perl</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This <tt>mod_perl</tt> handle supports the delivery of the content of [[API:EPrints/DataObj/File|EPrints::DataObj::File]] objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Defined HTTP Headers===<br /> These headers will be set by this module, where possible.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition====<br /> <br /> The string <tt>"inline; filename=FILENAME"</tt> where <tt>FILENAME</tt> is the <tt>filename</tt> value of the file object.<br /> <br /> If the <tt>download</tt> CGI parameter is true disposition is changed from <tt>inline</tt> to <tt>attachment</tt>, which will present a download dialog box in sane browsers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Length====<br /> <br /> The <tt>filesize</tt> value of the file object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-MD5====<br /> <br /> The MD5 of the file content in base-64 encoding if the <tt>hash</tt> value is set and <tt>hash_type</tt> is <tt>MD5</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type====<br /> <br /> The <tt>mime_type</tt> value of the file object, or <tt>application/octet-stream</tt> if not set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====ETag====<br /> <br /> The <tt>hash</tt> value of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Expires====<br /> <br /> The current time + 365 days, if the <tt>mtime</tt> value is set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Last-Modified====<br /> <br /> The <tt>mtime</tt> of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Accept-Ranges====<br /> <br /> Sets <tt>Accept-Ranges</tt> to bytes.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Recognised HTTP Headers===<br /> The following headers are recognised by this module.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-Modified-Since====<br /> <br /> If greater than or equal to the <tt>mtime</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-None-Match====<br /> <br /> If differs from the <tt>hash</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Storage::handler( $r )<br /> Handler for serving document files and thumbnails.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Storage&diff=15682 API:EPrints/Apache/Storage 2023-03-15T17:16:11Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Storage.pm|package_name=EPrints::Apache::Storage}}[[Category:API|STORAGE]][[Category:API:EPrints/Apache|STORAGE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::Storage - deliver file objects via <tt>mod_perl</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This mod_perl handle supports the delivery of the content of [[API:EPrints/DataObj/File|EPrints::DataObj::File]] objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Defined HTTP Headers===<br /> These headers will be set by this module, where possible.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition====<br /> <br /> The string <tt>"inline; filename=FILENAME"</tt> where <tt>FILENAME</tt> is the <tt>filename</tt> value of the file object.<br /> <br /> If the <tt>download</tt> CGI parameter is true disposition is changed from <tt>inline</tt> to <tt>attachment</tt>, which will present a download dialog box in sane browsers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Length====<br /> <br /> The <tt>filesize</tt> value of the file object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-MD5====<br /> <br /> The MD5 of the file content in base-64 encoding if the <tt>hash</tt> value is set and <tt>hash_type</tt> is <tt>MD5</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type====<br /> <br /> The <tt>mime_type</tt> value of the file object, or <tt>application/octet-stream</tt> if not set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====ETag====<br /> <br /> The <tt>hash</tt> value of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Expires====<br /> <br /> The current time + 365 days, if the <tt>mtime</tt> value is set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Last-Modified====<br /> <br /> The <tt>mtime</tt> of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Accept-Ranges====<br /> <br /> Sets <tt>Accept-Ranges</tt> to bytes.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Recognised HTTP Headers===<br /> The following headers are recognised by this module.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-Modified-Since====<br /> <br /> If greater than or equal to the <tt>mtime</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-None-Match====<br /> <br /> If differs from the <tt>hash</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Storage::handler( $r )<br /> Handler for serving document files and thumbnails.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Storage&diff=15681 API:EPrints/Apache/Storage 2023-03-15T17:15:14Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Storage.pm|package_name=EPrints::Apache::Storage}}[[Category:API|STORAGE]][[Category:API:EPrints/Apache|STORAGE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::Storage - deliver file objects via <tt>mod_perl</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This mod_perl handle supports the delivery of the content of [[API:EPrints/DataObj/File|EPrints::DataObj::File]] objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Defined HTTP Headers===<br /> These headers will be set by this module, where possible.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition====<br /> <br /> The string <tt>inline; filename=FILENAME</tt> where <tt>FILENAME</tt> is the <tt>filename</tt> value of the file object.<br /> <br /> If the <tt>download</tt> CGI parameter is true disposition is changed from <tt>inline</tt> to <tt>attachment</tt>, which will present a download dialog box in sane browsers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Length====<br /> <br /> The <tt>filesize</tt> value of the file object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-MD5====<br /> <br /> The MD5 of the file content in base-64 encoding if the <tt>hash</tt> value is set and <tt>hash_type</tt> is <tt>MD5</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type====<br /> <br /> The <tt>mime_type</tt> value of the file object, or <tt>application/octet-stream</tt> if not set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====ETag====<br /> <br /> The <tt>hash</tt> value of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Expires====<br /> <br /> The current time + 365 days, if the <tt>mtime</tt> value is set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Last-Modified====<br /> <br /> The <tt>mtime</tt> of the file object, if set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Accept-Ranges====<br /> <br /> Sets <tt>Accept-Ranges</tt> to bytes.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Recognised HTTP Headers===<br /> The following headers are recognised by this module.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-Modified-Since====<br /> <br /> If greater than or equal to the <tt>mtime</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====If-None-Match====<br /> <br /> If differs from the <tt>hash</tt> value of the file object returns <tt>304 Not Modified</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Storage::handler( $r )<br /> Handler for serving document files and thumbnails.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/SiteMap&diff=15680 API:EPrints/Apache/SiteMap 2023-03-15T17:11:07Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/SiteMap.pm|package_name=EPrints::Apache::SiteMap}}[[Category:API|SITEMAP]][[Category:API:EPrints/Apache|SITEMAP]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::SiteMap''' - Generates a dynamic sitemap.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This has been somewhat superseded by the {{API:PodLink|file=bin|package_name=bin|section=generate_sitemap|text=bin/generate_sitemap}} script, which generates a more useful output for Google indexing.<br /> <br /> This handler has been heavily modified in order to support a static ''sitemap.xml'' file in addition to the semantic web crawling extensions provided by EPrints. The modified handler inserts the semantic web crawling extensions into the existing ''sitemap.xml'' if it exists, or creates a new document if it doesn't. The original handler is now in the <tt>_insert_semantic_web_extensions</tt> below.<br /> <br /> If the static sitemap XML is a <tt>sitemapindex</tt>, this handler inserts a new <tt>&lt;sitemap</tt>&gt; element into the index, which directs crawlers to a ''sitemap-sc.xml'' URL that contains the semantic web sitemap generated by <tt>_insert_semantic_web_extensions</tt>. This handler also implements the <tt>sitemap-sc.xml</tt> URL.<br /> <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::SiteMap::handler( $r )<br /> Handler for managing EPrints requests for dynamically generated ''sitemap.xml'' or ''sitemap-sc.xml'' (or returning static version if that exists).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/RobotsTxt&diff=15679 API:EPrints/Apache/RobotsTxt 2023-03-15T17:10:58Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/RobotsTxt.pm|package_name=EPrints::Apache::RobotsTxt}}[[Category:API|ROBOTSTXT]][[Category:API:EPrints/Apache|ROBOTSTXT]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::RobotsTxt''' - Generates a dynamic robots.txt.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Generate a dynamic output for request of ''/robots.txt''<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::RobotsTxt::handler( $r )<br /> Handler for managing EPrints requests for dynamically generated ''robots.txt''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHTCopyright 2023 University of Southampton. EPrints 3.4 is supplied by EPrints Services.<br /> <br /> http://www.eprints.org/eprints-3.4/<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHT<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/RobotsTxt&diff=15678 API:EPrints/Apache/RobotsTxt 2023-03-15T17:01:54Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/RobotsTxt.pm|package_name=EPrints::Apache::RobotsTxt}}[[Category:API|ROBOTSTXT]][[Category:API:EPrints/Apache|ROBOTSTXT]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::RobotsTxt<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> Generate a dynamic output for request of ''/robots.txt''<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::RobotsTxt::handler( $r )<br /> Handler for managing EPrints requests for dynamically generated ''robots.txt''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHTCopyright 2023 University of Southampton. EPrints 3.4 is supplied by EPrints Services.<br /> <br /> http://www.eprints.org/eprints-3.4/<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> COPYRIGHT<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Rewrite&diff=15677 API:EPrints/Apache/Rewrite 2023-03-15T17:00:02Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Rewrite.pm|package_name=EPrints::Apache::Rewrite}}[[Category:API|REWRITE]][[Category:API:EPrints/Apache|REWRITE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Rewrite''' - rewrite cosmetic URLs to internally useful ones.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This rewrites the URL Apache receives based on certain things, such as the current language.<br /> <br /> Expands ''/archive/00000123/*'' to ''/archive/00/00/01/23/*'' and so forth.<br /> <br /> This should only ever be called from within the <tt>mod_perl</tt> system.<br /> <br /> This also causes some pages to be regenerated on demand, if they are stale.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Rewrite::handler( $r )<br /> Handler for managing an EPrints rewrite request <tt>$r</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_permanent===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir_permanent( $r, $url )<br /> Redirect permanently (<tt>301 Moved Permanently</tt>) request <tt>$r</tt> to URL specified by <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir( $r, $url )<br /> Redirect temporarily (<tt>302 Found</tt>) request <tt>$r</tt> to URL specified by <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_see_other===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir_see_other( $r, $url )<br /> Redirect the request <tt>$r</tt> to another resource (<tt>303 See Other</tt>) specified by the URL in <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===content_negotiate_best_plugin===<br /> <br /> $rc = EPrints::Apache::Rewrite::content_negotiate_best_plugin( $repository, %o )<br /> Determine the best content type to provide based on the options provided by <tt>%o</tt>.<br /> <br /> Returns a string containing the best content type (e.g. <tt>text/html</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Rewrite&diff=15676 API:EPrints/Apache/Rewrite 2023-03-15T16:58:05Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Rewrite.pm|package_name=EPrints::Apache::Rewrite}}[[Category:API|REWRITE]][[Category:API:EPrints/Apache|REWRITE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Rewrite''' - rewrite cosmetic URL's to internally useful ones.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This rewrites the URL Apache receives based on certain things, such as the current language.<br /> <br /> Expands ''/archive/00000123/*'' to ''/archive/00/00/01/23/*'' and so forth.<br /> <br /> This should only ever be called from within the <tt>mod_perl</tt> system.<br /> <br /> This also causes some pages to be regenerated on demand, if they are stale.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::Rewrite::handler( $r )<br /> Handler for managing an EPrints rewrite request <tt>$r</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_permanent===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir_permanent( $r, $url )<br /> Redirect permanently (<tt>301 Moved Permanently</tt>) request <tt>$r</tt> to URL specified by <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir( $r, $url )<br /> Redirect temporarily (<tt>302 Found</tt>) request <tt>$r</tt> to URL specified by <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_see_other===<br /> <br /> $rc = EPrints::Apache::Rewrite::redir_see_other( $r, $url )<br /> Redirect the request <tt>$r</tt> to another resource (<tt>303 See Other</tt>) specified by the URL in <tt>$url</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===content_negotiate_best_plugin===<br /> <br /> $rc = EPrints::Apache::Rewrite::content_negotiate_best_plugin( $repository, %o )<br /> Determine the best content type to provide based on the options provided by <tt>%o</tt>.<br /> <br /> Returns a string containing the best content type (e.g. <tt>text/html</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/REST&diff=15675 API:EPrints/Apache/REST 2023-03-15T15:48:43Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/REST.pm|package_name=EPrints::Apache::REST}}[[Category:API|REST]][[Category:API:EPrints/Apache|REST]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::REST - Representational state transfer<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> REST API for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::REST::handler( $r )<br /> Handler for EPrints' REST API<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_add_slash===<br /> <br /> $rc = EPrints::Apache::REST::redir_add_slash( $repository )<br /> Redirect to the current request for the <tt>$repository</tt> with an added slash <tt>/</tt> at the end of the path.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_top_level===<br /> <br /> $rc = EPrints::Apache::REST::serve_top_level( $repository, @path )<br /> Serve top level list of datasets (i.e. <tt>eprint</tt>, <tt>user</tt> and <tt>subject</tt>) or pass onto [[API:EPrints/Apache/REST#serve_dataset|serve_dataset]]. dependent of <tt>@path</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_dataset===<br /> <br /> $rc = EPrints::Apache::REST::serve_dataset( $repository, $dataset, @path )<br /> Serve listing of data objects for a particular dataset, pass onto [[API:EPrints/Apache/REST#serve_dataobj|serve_dataobj]], [[API:EPrints/Apache/REST#get_dataobj_xml|get_dataobj_xml]] or [[API:EPrints/Apache/REST#put_dataobj_xml|put_dataobj_xml]] or return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_dataobj===<br /> <br /> $rc = EPrints::Apache::REST::serve_dataobj( $repository, $object, $rights_object, @path )<br /> Serve HTML, XML or text version of data object from <tt>GET</tt> or <tt>PUT</tt> request. Pass onto [[API:EPrints/Apache/REST#serve_field|serve_field]] or otherwise return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_field===<br /> <br /> $rc = EPrints::Apache::REST::serve_field( $repository, $object, $rights_object, $field, $value, @path )<br /> Serve HTML, XML or text version of data object from <tt>GET</tt> requests. Pass on field requests onto [[API:EPrints/Apache/REST#serve_field_single|serve_field_single]] or otherwise return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_field_single===<br /> <br /> $rc = EPrints::Apache::REST::serve_field_single( $repository, $object, $rights_object, $field, $value, @path )<br /> Serve single field representation by passing onto [[API:EPrints/Apache/REST#serve_subobject|serve_subobject]], [[API:EPrints/Apache/REST#serve_compound|serve_compound]] or <tt>/serve_name</tt> base on type of field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_suboject===<br /> <br /> $rc = EPrints::Apache::REST::serve_suboject( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves sub-object by passing onto [[API:EPrints/Apache/REST#serve_dataobj|serve_dataobj]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_compound===<br /> <br /> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves compound field by iterating over sub-field, calling [[API:EPrints/Apache/REST#serve_field_single|serve_field_single]] where appropriate.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_compound===<br /> <br /> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves name field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_html===<br /> <br /> $rc = EPrints::Apache::REST::render_html( $html, $title )<br /> Renders HTML for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_html===<br /> <br /> $rc = EPrints::Apache::REST::send_html( $repository, $html, $title )<br /> Sends HTML response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_xml===<br /> <br /> $rc = EPrints::Apache::REST::send_xml( $repository, $xmldata )<br /> Sends XML response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_plaintext===<br /> <br /> $rc = EPrints::Apache::REST::send_plaintext( $repository, $content )<br /> Sends plain text response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===allowed_methods===<br /> <br /> $allowed = EPrints::Apache::REST::allowed_methods( $repository, @methods )<br /> Checks if method for request is contained with the <tt>@methods</tt> array of allowed methods. Setting and sending HTTP response headers and code as appropriate.<br /> <br /> Returns boolean depending on whether the request method is allowed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===allowed_methods===<br /> <br /> $allowed = EPrints::Apache::REST::allowed_methods( $priv $repository, $rights_object )<br /> Checks is privilege <tt>$priv</tt> is permitted for the current user and sets HTTP response code as appropriate.<br /> <br /> Returns boolean depending on whether current user has permitted privilege.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_dataobj_xml===<br /> <br /> $rc = EPrints::Apache::REST::get_dataobj_xml( $repository, $object, $rights_object )<br /> Returns XML for REST request to <tt>GET</tt> a data object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_dataobj_xml===<br /> <br /> $rc = EPrints::Apache::REST::put_dataobj_xml( $repository, $object, $rights_object )<br /> Returns XML for REST request to (non-implemented) <tt>PUT</tt> a data object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_field_text===<br /> <br /> $rc = EPrints::Apache::REST::get_field_text( $repository, $object, $rights_object, $field )<br /> Returns text for REST request to <tt>GET</tt> a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_field_xml===<br /> <br /> $rc = EPrints::Apache::REST::get_field_xml( $repository, $object, $rights_object, $field )<br /> Returns XML for REST request to <tt>GET</tt> a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_field_xml===<br /> <br /> $rc = EPrints::Apache::REST::put_field_xml( $repository, $object, $rights_object, $field )<br /> Returns XML for REST request to <tt>PUT</tt> a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_field_txt===<br /> <br /> $rc = EPrints::Apache::REST::put_field_txt( $repository, $object, $rights_object, $field )<br /> Returns text for REST request to <tt>PUT</tt> a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/LogHandler&diff=15674 API:EPrints/Apache/LogHandler 2023-03-15T15:31:45Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/LogHandler.pm|package_name=EPrints::Apache::LogHandler}}[[Category:API|LOGHANDLER]][[Category:API:EPrints/Apache|LOGHANDLER]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::LogHandler - Main handler for Apache log events<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> To enable the Apache::LogHandler add to your ArchiveConfig:<br /> <br /> $c-&gt;{loghandler}-&gt;{enable} = 1;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DATA FORMAT==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===requester===<br /> <br /> The requester is stored using their IP in URN format: <tt>urn:ip:x.x.x.x</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serviceType===<br /> <br /> ServiceType is in format {{API:PodLink|file=http:|package_name=http:|section=|text=info:ofi/fmt:kev:mtx:sch_svc}}.<br /> <br /> The value is encoded as <tt>?name=yes</tt> (where <tt>name</tt> is one of the services defined).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===referent, referringEntity===<br /> <br /> These are stored in URN format: <tt>info:oai:repositoryid:eprintid</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===referent_docid===<br /> <br /> The document id as a fragment of the referent: <tt>#docid</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Class Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====eprints_apache_loghandler_handler====<br /> <br /> EPrints:Apache::LogHandler::handler<br /> Empty (as deprecated) handler method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_robot====<br /> <br /> EPrints:Apache::LogHandler::is_robot( $r, $ip )<br /> Test if request <tt>$r</tt> is a robot based on <tt>User-Agent</tt> or if <tt>$ip</tt> is listed as a robot.<br /> <br /> Returns a boolean dependent or whether request has determined to be a robot.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Object Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====document====<br /> <br /> $handler-&gt;document( $r )<br /> A request on a document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====eprint====<br /> <br /> $handler-&gt;eprint( $r )<br /> A request on an eprint abstract page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> [[API:EPrints/DataObj/Access|EPrints::DataObj::Access]]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/CRUD&diff=15673 API:EPrints/Apache/CRUD 2023-03-15T15:23:12Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/CRUD.pm|package_name=EPrints::Apache::CRUD}}[[Category:API|CRUD]][[Category:API:EPrints/Apache|CRUD]]<div><br /> <br /> <br /> {{Version|since=3.3.0}}<br /> ==NAME==<br /> '''EPrints::Apache::CRUD''' - Create, read, update and delete via HTTP<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> $crud = EPrints::Apache::CRUD-&gt;new(<br /> repository =&gt; $repo,<br /> request =&gt; $r,<br /> datasetid =&gt; "eprint",<br /> dataobjid =&gt; "23",<br /> );<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> The CRUD (Create/Read/Update/Delete) module provides the Web API for manipulating content on the server. The API is an AtomPub implementation that exposes Import and Export plugins via simple URLs and HTTP content type negotiation.<br /> <br /> You should use the &lt;link&gt; entries in the repository's home page to locate the CRUD endpoint, as they may change in the future:<br /> <br /> &lt;link rel="Sword" href="https://myrepo/sword-app/servicedocument" /&gt;<br /> &lt;link rel="SwordDeposit" href="https://myrepo/id/contents" /&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Examples===<br /> Create a new eprint based on a single file:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Add a file to an existing eprint:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Disposition: attachment; filename=hello.txt' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get an eprint's metadata in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get the list of contents (documents) of an eprint in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> You can find more examples in the ''tests/84_sword.t'' unit test.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===URI Layout===<br /> These URIs are relative to your EPrints HTTP/HTTPs root.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/contents GET,HEAD,OPTIONS,POST====<br /> <br /> Requires authentication.<br /> <br /> <tt>GET</tt> a list of the eprints owned by the user. <tt>POST</tt> to create a new EPrint object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid] DELETE,GET,HEAD,OPTIONS,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> an object's metadata or, for {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} objects, the file content. <tt>PUT</tt> to replace the metadata and/or contents (see [[API:EPrints/Apache/CRUD#Updating_complex_objects_using_PUT|Updating complex objects using PUT]]). If the object does not exist will attempt to create it with the given dataobjid (requires <tt>upsert</tt> privilege).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid]/contents DELETE,GET,HEAD,OPTIONS,POST,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> the logical contents of the object: documents for eprints or files for documents. <tt>PUT</tt> to replace the existing contents or POST to add to the existing contents.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===HTTP Content Negotiation===<br /> <tt>GET</tt>/<tt>HEAD</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugins. <tt>POST</tt>/<tt>PUT</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugins.<br /> <br /> The plugin used depends on the request's <tt>Accept</tt> (<tt>GET</tt>/<tt>HEAD</tt>) or <tt>Content-Type</tt> (<tt>POST</tt>/<tt>PUT</tt>) header and the type of object being acted on. For example, the following request:<br /> <br /> GET /id/eprint/23 HTTP/1.1<br /> Accept: application/vnd.eprints.data+xml<br /> <br /> Will search for an Export plugin that accepts objects of type <tt>dataobj/eprint</tt> and can produce output in the MIME type <tt>application/vnd.eprints.data+xml</tt>. This will most likely be the {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} plugin.<br /> <br /> In addition to the general plugin negotiation behaviour some special cases are supported to improve compatibility with Atom Pub/Web Browser clients:<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/eprint/...====<br /> <br /> Requesting {{API:PodLink|file=EPrints/DataObj/EPrint|package_name=EPrints::DataObj::EPrint|section=|text=EPrint}} objects as text/html will result in a <tt>303 Redirect</tt> to the eprint object's abstract page or, if the eprint is not public, its {{API:PodLink|file=EPrints/Plugin/Screen/EPrint/View|package_name=EPrints::Plugin::Screen::EPrint::View|section=|text=View}} page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/document/.../contents====<br /> <br /> Requesting the <tt>/contents</tt> of a {{API:PodLink|file=EPrints/DataObj/Document|package_name=EPrints::DataObj::Document|section=|text=Document}} object will return the content of the document's main file.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/file/...====<br /> <br /> Requesting a {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} object with no <tt>Accept</tt> header (or <tt>*/*</tt>) will return the file's content.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====POST /id/.../contents====<br /> <br /> When creating new records via POST, content negotiation is performed against the Import plugins.<br /> <br /> If no Import plugin supports the <em>Content-Type</em> header the content will be treated as <tt>application/octet-stream</tt> and stored in a new object. The resulting Atom entry will describe the new object (e.g. the <tt>eprint</tt> object in which the new <tt>document</tt> and <tt>file</tt> objects were created).<br /> <br /> Otherwise, the result will depend on the Import plugin's output. Import plugins may produce a single object, multiple objects or an object plus content file(s).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type header====<br /> <br /> If no <tt>Content-Type</tt> header is given the MIME type defaults to <tt>application/octet-stream</tt> for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition header====<br /> <br /> If the <tt>Content-Disposition</tt> header is missing or does not contain a <tt>filename</tt> parameter the filename defaults to ''main.bin'' for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Updating complex objects using PUT===<br /> Eprint objects contain zero or more documents, which each contain zero or more files. When you update (<tt>PUT</tt>) an eprint object the contained documents will only be replaced if the Import plugin defines new documents e.g. the Atom Import plugin will never define new documents so <tt>PUT</tt>ing Atom content will only update the eprint's metadata. <tt>PUT</tt>ing {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} will replace the documents if you include a <tt>&lt;documents</tt>&gt; XML element.<br /> <br /> <tt>PUT</tt>ing to <tt>/contents</tt> will always replace all contents - <tt>PUT</tt>ing to <tt>/eprint/23/contents</tt> is equivalent to <tt>DELETE /eprint/23/contents</tt> then <tt>POST /eprint/23/contents</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===PUT/DELETE from Javascript===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Upserting objects with PUT===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==CONSTANTS ==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_USER_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to user submitting content (i.e. ''/id/content'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATASET===<br /> <br /> Restrict the scope of the CRUD request to a dataset (i.e. ''/id/FOO...'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATAOBJ===<br /> <br /> Restrict the scope of the CRUD request to a data object (i.e. ''/id/FOO/BAR'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_FIELD===<br /> <br /> Restrict the scope of the CRUD request to a field of data object (i.e. ''/id/FOO/BAR/BAZ'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to the contents of data object (i.e. ''/id/FOO/BAR/contents'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_SERVICEDOCUMENT===<br /> <br /> Restrict the scope of the CRUD request to the service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Constructor Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====new====<br /> <br /> $crud = EPrints::Apache::CRUD-&gt;new( %params )<br /> Return a new CRUD request using parameters given in <tt>%params</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Class Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====generate_error_document====<br /> <br /> $error_document = EPrints::Apache::CRUD::generate_error_document( $repo, %opts )<br /> Return error document for [[API:EPrints/Repository|EPrints::Repository]] <tt>$repo</tt> using options from <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_true====<br /> <br /> $boolean = EPrints::Apache::CRUD::is_true( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>true</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_false====<br /> <br /> $boolean = EPrints::Apache::CRUD::is_false( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>false</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Object Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====repository====<br /> <br /> $repo = $crud-&gt;repository()<br /> Returns the current repository.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====request====<br /> <br /> $r = $crud-&gt;request()<br /> Returns the current {{API:PodLink|file=Apache2/RequestUtil|package_name=Apache2::RequestUtil|section=|text=Apache2::RequestUtil}}.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====method====<br /> <br /> $method = $crud-&gt;method()<br /> Returns the HTTP method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====scope====<br /> <br /> $scope = $crud-&gt;scope()<br /> Returns the scope of the action being performed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataset====<br /> <br /> $dataset = $crud-&gt;dataset()<br /> Returns the current dataset (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataobj====<br /> <br /> $dataobj = $crud-&gt;dataobj()<br /> Returns the current dataobj (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====field====<br /> <br /> $field = $crud-&gt;field()<br /> Returns the current field (if available);<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====headers====<br /> <br /> $headers = $crud-&gt;headers()<br /> Get the processed headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====options====<br /> <br /> @verbs = $crud-&gt;options()<br /> Returns the available HTTP verbs for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin====<br /> <br /> $plugin = $crud-&gt;plugin()<br /> Returns the current plugin (if available).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_write====<br /> <br /> $bool = $crud-&gt;is_write()<br /> Returns <tt>true</tt> if the request is not a read-only method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====accept_type====<br /> <br /> $accept_type = $crud-&gt;accept_type()<br /> Returns the EPrints type for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====check_packaging====<br /> <br /> $rc = $crud-&gt;check_packaging()<br /> Check the Packaging header is ok, if given.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====resolve_relations====<br /> <br /> $dataobj = $crud-&gt;resolve_relations( $dataobj [, @relations ] )<br /> Resolve the relation path from <tt>$dataobj</tt> and return the resulting data object.<br /> <br /> Returns c&lt;undef&gt; if there is no such related object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authen====<br /> <br /> $rc = $crud-&gt;authen<br /> Returns HTTP code based of whether CRUD request can be authenticated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authz====<br /> <br /> $rc = $crud-&gt;authz<br /> Returns HTTP code based of whether CRUD request can be authorized.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====parse_input====<br /> <br /> $list = $crud-&gt;parse_input( $plugin, $f [, %params ] )<br /> Parse the content submitted by the user using the given <tt>$plugin</tt>. <tt>$f</tt> is called by c&lt;epdata_to_dataobj&gt; to convert EPrints data markup to a data object. <tt>%params</tt> are passed to the plugin's <tt>input_fh</tt> method.<br /> <br /> Returns <tt>undef</tt> on error. Otherwise returns an [[API:EPrints/List|EPrints::List]] of data objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====create_dataobj====<br /> <br /> $dataobj = $crud-&gt;create_dataobj( $owner, $epdata )<br /> Creates data object as user $owner with metadata from $epdata<br /> <br /> Returns an [[API:EPrints/DataObj|EPrints::DataObj]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====import_plugins====<br /> <br /> @plugins = $crud-&gt;import_plugins( [ %params ] )<br /> Returns all matching import plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====export_plugins====<br /> <br /> @plugins = $crud-&gt;export_plugins( [ %params ] )<br /> Returns all matching export plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====content_negotiate_best_plugin====<br /> <br /> $plugin = $crud-&gt;content_negotiate_best_plugin()<br /> Work out the best plugin to export/update an object based on the client headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====crud====<br /> <br /> EPrints::Apache::CRUD( $media_range )<br /> Takes the <tt>$media_range</tt> string and returns array of acceptable MIME types. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 for more detail.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====handler====<br /> <br /> $rc = $crud-&gt;handler<br /> Handler of CRUD requests.<br /> <br /> Returns HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====delete====<br /> <br /> $rc = $crud-&gt;DELETE()<br /> Handle <tt>DELETE</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can't perform <tt>DELETE</tt> on ''/id/contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> No such object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_conflict====<br /> <br /> HTTP_CONFLICT<br /> Lock conflict with another user.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Successfully removed the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====get====<br /> <br /> $rc = $crud-&gt;GET( [ $owner ] )<br /> Handle <tt>GET</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> No sub-objects in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_acceptable====<br /> <br /> HTTP_NOT_ACCEPTABLE<br /> More than one sub-object in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugin matches the <tt>Accept</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_see_other====<br /> <br /> HTTP_SEE_OTHER<br /> Redirect to a non-CRUD EPrints page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> Object not found.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_ok====<br /> <br /> HTTP_OK<br /> Object outputted successfully.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====post====<br /> <br /> $rc = $crud-&gt;POST( [ $owner ] )<br /> Handle <tt>POST</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can only POST to ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_bad_request====<br /> <br /> HTTP_BAD_REQUEST<br /> No plugin for the SWORD <tt>Packaging</tt> header.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object(s) successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put====<br /> <br /> $rc = $crud-&gt;PUT( [ $owner ] )<br /> Handle <tt>PUT</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugin matched the <tt>Content-Type</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_range_not_satisfiable====<br /> <br /> HTTP_RANGE_NOT_SATISFIABLE<br /> <tt>Range</tt> header is invalid or unsupported for the object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_forbidden====<br /> <br /> HTTP_FORBIDDEN<br /> User does not have permission to create/update the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object was successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Object was successfully updated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put_contents====<br /> <br /> $rc = $crud-&gt;PUT_contents( [ $owner ] )<br /> Equivalent to <tt>DELETE /id/.../contents</tt> then <tt>POST /id/.../contents</tt>.<br /> <br /> See [[API:EPrints/Apache/CRUD#DELETE|DELETE]] and [[API:EPrints/Apache/CRUD#POST|POST]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====metadata_relevant====<br /> <br /> $crud-&gt;metadata_relevant( $file )<br /> Test and if suitable use <tt>$file</tt> as metadata source to update the associated [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====servicedocument====<br /> <br /> $crud-&gt;servicedocument<br /> Generate response containing CRUD service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====on_behalf_of====<br /> <br /> $rc = $crud-&gt;on_behalf_of( $user )<br /> Submit CRUD request on behalf of another user.<br /> <br /> Returns HTTPS response code based on whether request on behalf of is permitted.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_file_ok====<br /> <br /> $boolean = $crud-&gt;is_file_ok( $epdata )<br /> Tests if files with <tt>$epdata</tt> were uploaded with corruption.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====process_headers====<br /> <br /> $boolean = $crud-&gt;process_headers<br /> Process headers of CRUD request<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====sword_error====<br /> <br /> $boolean = $crud-&gt;sword_error( %opts )<br /> Generate SWORD error documents based on provided <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin_error====<br /> <br /> $boolean = $crud-&gt;plugin_error( $plugin, $messages )<br /> Generate error message for import <tt>$plugin</tt> used with <tt>$messages</tt> provided.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====send_response====<br /> <br /> $rc = $crud-&gt;send_response( $status, $content_type, $content )<br /> Output response to CRUD request with HTTP status code <tt>$status</tt>, content type <tt>$content_type</tt>.<br /> <br /> Returns HTTP response code <tt>OK</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> http://en.wikipedia.org/wiki/Create,_read,_update_and_delete<br /> <br /> http://en.wikipedia.org/wiki/Content_negotiation<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/CRUD&diff=15672 API:EPrints/Apache/CRUD 2023-03-15T15:21:51Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/CRUD.pm|package_name=EPrints::Apache::CRUD}}[[Category:API|CRUD]][[Category:API:EPrints/Apache|CRUD]]<div><br /> <br /> <br /> {{Version|since=3.3.0}}<br /> ==NAME==<br /> '''EPrints::Apache::CRUD''' - Create, read, update and delete via HTTP<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> $crud = EPrints::Apache::CRUD-&gt;new(<br /> repository =&gt; $repo,<br /> request =&gt; $r,<br /> datasetid =&gt; "eprint",<br /> dataobjid =&gt; "23",<br /> );<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> The CRUD (Create/Read/Update/Delete) module provides the Web API for manipulating content on the server. The API is an AtomPub implementation that exposes Import and Export plugins via simple URLs and HTTP content type negotiation.<br /> <br /> You should use the &lt;link&gt; entries in the repository's home page to locate the CRUD endpoint, as they may change in the future:<br /> <br /> &lt;link rel="Sword" href="https://myrepo/sword-app/servicedocument" /&gt;<br /> &lt;link rel="SwordDeposit" href="https://myrepo/id/contents" /&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Examples===<br /> Create a new eprint based on a single file:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Add a file to an existing eprint:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Disposition: attachment; filename=hello.txt' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get an eprint's metadata in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get the list of contents (documents) of an eprint in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> You can find more examples in the ''tests/84_sword.t'' unit test.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===URI Layout===<br /> These URIs are relative to your EPrints HTTP/HTTPs root.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/contents GET,HEAD,OPTIONS,POST====<br /> <br /> Requires authentication.<br /> <br /> <tt>GET</tt> a list of the eprints owned by the user. <tt>POST</tt> to create a new EPrint object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid] DELETE,GET,HEAD,OPTIONS,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> an object's metadata or, for {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} objects, the file content. <tt>PUT</tt> to replace the metadata and/or contents (see [[API:EPrints/Apache/CRUD#Updating_complex_objects_using_PUT|Updating complex objects using PUT]]). If the object does not exist will attempt to create it with the given dataobjid (requires <tt>upsert</tt> privilege).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid]/contents DELETE,GET,HEAD,OPTIONS,POST,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> the logical contents of the object: documents for eprints or files for documents. <tt>PUT</tt> to replace the existing contents or POST to add to the existing contents.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===HTTP Content Negotiation===<br /> <tt>GET</tt>/<tt>HEAD</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugins. <tt>POST</tt>/<tt>PUT</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugins.<br /> <br /> The plugin used depends on the request's <tt>Accept</tt> (<tt>GET</tt>/<tt>HEAD</tt>) or <tt>Content-Type</tt> (<tt>POST</tt>/<tt>PUT</tt>) header and the type of object being acted on. For example, the following request:<br /> <br /> GET /id/eprint/23 HTTP/1.1<br /> Accept: application/vnd.eprints.data+xml<br /> <br /> Will search for an Export plugin that accepts objects of type <tt>dataobj/eprint</tt> and can produce output in the MIME type <tt>application/vnd.eprints.data+xml</tt>. This will most likely be the {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} plugin.<br /> <br /> In addition to the general plugin negotiation behaviour some special cases are supported to improve compatibility with Atom Pub/Web Browser clients:<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/eprint/...====<br /> <br /> Requesting {{API:PodLink|file=EPrints/DataObj/EPrint|package_name=EPrints::DataObj::EPrint|section=|text=EPrint}} objects as text/html will result in a <tt>303 Redirect</tt> to the eprint object's abstract page or, if the eprint is not public, its {{API:PodLink|file=EPrints/Plugin/Screen/EPrint/View|package_name=EPrints::Plugin::Screen::EPrint::View|section=|text=View}} page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/document/.../contents====<br /> <br /> Requesting the <tt>/contents</tt> of a {{API:PodLink|file=EPrints/DataObj/Document|package_name=EPrints::DataObj::Document|section=|text=Document}} object will return the content of the document's main file.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/file/...====<br /> <br /> Requesting a {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} object with no <tt>Accept</tt> header (or <tt>*/*</tt>) will return the file's content.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====POST /id/.../contents====<br /> <br /> When creating new records via POST, content negotiation is performed against the Import plugins.<br /> <br /> If no Import plugin supports the <em>Content-Type</em> header the content will be treated as <tt>application/octet-stream</tt> and stored in a new object. The resulting Atom entry will describe the new object (e.g. the <tt>eprint</tt> object in which the new <tt>document</tt> and <tt>file</tt> objects were created).<br /> <br /> Otherwise, the result will depend on the Import plugin's output. Import plugins may produce a single object, multiple objects or an object plus content file(s).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type header====<br /> <br /> If no <tt>Content-Type</tt> header is given the MIME type defaults to <tt>application/octet-stream</tt> for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition header====<br /> <br /> If the <tt>Content-Disposition</tt> header is missing or does not contain a <tt>filename</tt> parameter the filename defaults to ''main.bin'' for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Updating complex objects using PUT===<br /> Eprint objects contain zero or more documents, which each contain zero or more files. When you update (<tt>PUT</tt>) an eprint object the contained documents will only be replaced if the Import plugin defines new documents e.g. the Atom Import plugin will never define new documents so <tt>PUT</tt>ing Atom content will only update the eprint's metadata. <tt>PUT</tt>ing {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} will replace the documents if you include a <tt>&lt;documents</tt>&gt; XML element.<br /> <br /> <tt>PUT</tt>ing to <tt>/contents</tt> will always replace all contents - <tt>PUT</tt>ing to <tt>/eprint/23/contents</tt> is equivalent to <tt>DELETE /eprint/23/contents</tt> then <tt>POST /eprint/23/contents</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===PUT/DELETE from Javascript===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Upserting objects with PUT===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==CONSTANTS ==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_USER_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to user submitting content (i.e. ''/id/content'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATASET===<br /> <br /> Restrict the scope of the CRUD request to a dataset (i.e. ''/id/FOO...'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATAOBJ===<br /> <br /> Restrict the scope of the CRUD request to a data object (i.e. ''/id/FOO/BAR'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_FIELD===<br /> <br /> Restrict the scope of the CRUD request to a field of data object (i.e. ''/id/FOO/BAR/BAZ'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to the contents of data object (i.e. ''/id/FOO/BAR/contents'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_SERVICEDOCUMENT===<br /> <br /> Restrict the scope of the CRUD request to the service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Constructor Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====new====<br /> <br /> $crud = EPrints::Apache::CRUD-&gt;new( %params )<br /> Return a new CRUD request using parameters given in <tt>%params</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Class Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====generate_error_document====<br /> <br /> $error_document = EPrints::Apache::Crud::generate_error_document( $repo, %opts )<br /> Return error document for [[API:EPrints/Repository|EPrints::Repository]] <tt>$repo</tt> using options from <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_true====<br /> <br /> $boolean = EPrints::Apache::Crud::is_true( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>true</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_false====<br /> <br /> $boolean = EPrints::Apache::Crud::is_false( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>false</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Object Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====repository====<br /> <br /> $repo = $crud-&gt;repository()<br /> Returns the current repository.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====request====<br /> <br /> $r = $crud-&gt;request()<br /> Returns the current {{API:PodLink|file=Apache2/RequestUtil|package_name=Apache2::RequestUtil|section=|text=Apache2::RequestUtil}}.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====method====<br /> <br /> $method = $crud-&gt;method()<br /> Returns the HTTP method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====scope====<br /> <br /> $scope = $crud-&gt;scope()<br /> Returns the scope of the action being performed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataset====<br /> <br /> $dataset = $crud-&gt;dataset()<br /> Returns the current dataset (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataobj====<br /> <br /> $dataobj = $crud-&gt;dataobj()<br /> Returns the current dataobj (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====field====<br /> <br /> $field = $crud-&gt;field()<br /> Returns the current field (if available);<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====headers====<br /> <br /> $headers = $crud-&gt;headers()<br /> Get the processed headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====options====<br /> <br /> @verbs = $crud-&gt;options()<br /> Returns the available HTTP verbs for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin====<br /> <br /> $plugin = $crud-&gt;plugin()<br /> Returns the current plugin (if available).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_write====<br /> <br /> $bool = $crud-&gt;is_write()<br /> Returns <tt>true</tt> if the request is not a read-only method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====accept_type====<br /> <br /> $accept_type = $crud-&gt;accept_type()<br /> Returns the EPrints type for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====check_packaging====<br /> <br /> $rc = $crud-&gt;check_packaging()<br /> Check the Packaging header is ok, if given.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====resolve_relations====<br /> <br /> $dataobj = $crud-&gt;resolve_relations( $dataobj [, @relations ] )<br /> Resolve the relation path from <tt>$dataobj</tt> and return the resulting data object.<br /> <br /> Returns c&lt;undef&gt; if there is no such related object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authen====<br /> <br /> $rc = $crud-&gt;authen<br /> Returns HTTP code based of whether CRUD request can be authenticated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authz====<br /> <br /> $rc = $crud-&gt;authz<br /> Returns HTTP code based of whether CRUD request can be authorized.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====parse_input====<br /> <br /> $list = $crud-&gt;parse_input( $plugin, $f [, %params ] )<br /> Parse the content submitted by the user using the given <tt>$plugin</tt>. <tt>$f</tt> is called by c&lt;epdata_to_dataobj&gt; to convert EPrints data markup to a data object. <tt>%params</tt> are passed to the plugin's <tt>input_fh</tt> method.<br /> <br /> Returns <tt>undef</tt> on error. Otherwise returns an [[API:EPrints/List|EPrints::List]] of data objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====create_dataobj====<br /> <br /> $dataobj = $crud-&gt;create_dataobj( $owner, $epdata )<br /> Creates data object as user $owner with metadata from $epdata<br /> <br /> Returns an [[API:EPrints/DataObj|EPrints::DataObj]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====import_plugins====<br /> <br /> @plugins = $crud-&gt;import_plugins( [ %params ] )<br /> Returns all matching import plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====export_plugins====<br /> <br /> @plugins = $crud-&gt;export_plugins( [ %params ] )<br /> Returns all matching export plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====content_negotiate_best_plugin====<br /> <br /> $plugin = $crud-&gt;content_negotiate_best_plugin()<br /> Work out the best plugin to export/update an object based on the client headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====crud====<br /> <br /> EPrints::Apache::CRUD( $media_range )<br /> Takes the <tt>$media_range</tt> string and returns array of acceptable MIME types. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 for more detail.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====handler====<br /> <br /> $rc = $crud-&gt;handler<br /> Handler of CRUD requests.<br /> <br /> Returns HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====delete====<br /> <br /> $rc = $crud-&gt;DELETE()<br /> Handle <tt>DELETE</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can't perform <tt>DELETE</tt> on ''/id/contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> No such object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_conflict====<br /> <br /> HTTP_CONFLICT<br /> Lock conflict with another user.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Successfully removed the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====get====<br /> <br /> $rc = $crud-&gt;GET( [ $owner ] )<br /> Handle <tt>GET</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> No sub-objects in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_acceptable====<br /> <br /> HTTP_NOT_ACCEPTABLE<br /> More than one sub-object in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugin matches the <tt>Accept</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_see_other====<br /> <br /> HTTP_SEE_OTHER<br /> Redirect to a non-CRUD EPrints page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> Object not found.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_ok====<br /> <br /> HTTP_OK<br /> Object outputted successfully.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====post====<br /> <br /> $rc = $crud-&gt;POST( [ $owner ] )<br /> Handle <tt>POST</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can only POST to ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_bad_request====<br /> <br /> HTTP_BAD_REQUEST<br /> No plugin for the SWORD <tt>Packaging</tt> header.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object(s) successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put====<br /> <br /> $rc = $crud-&gt;PUT( [ $owner ] )<br /> Handle <tt>PUT</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugin matched the <tt>Content-Type</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_range_not_satisfiable====<br /> <br /> HTTP_RANGE_NOT_SATISFIABLE<br /> <tt>Range</tt> header is invalid or unsupported for the object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_forbidden====<br /> <br /> HTTP_FORBIDDEN<br /> User does not have permission to create/update the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object was successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Object was successfully updated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put_contents====<br /> <br /> $rc = $crud-&gt;PUT_contents( [ $owner ] )<br /> Equivalent to <tt>DELETE /id/.../contents</tt> then <tt>POST /id/.../contents</tt>.<br /> <br /> See [[API:EPrints/Apache/CRUD#DELETE|DELETE]] and [[API:EPrints/Apache/CRUD#POST|POST]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====metadata_relevant====<br /> <br /> $crud-&gt;metadata_relevant( $file )<br /> Test and if suitable use <tt>$file</tt> as metadata source to update the associated [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====servicedocument====<br /> <br /> $crud-&gt;servicedocument<br /> Generate response containing CRUD service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====on_behalf_of====<br /> <br /> $rc = $crud-&gt;on_behalf_of( $user )<br /> Submit CRUD request on behalf of another user.<br /> <br /> Returns HTTPS response code based on whether request on behalf of is permitted.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_file_ok====<br /> <br /> $boolean = $crud-&gt;is_file_ok( $epdata )<br /> Tests if files with <tt>$epdata</tt> were uploaded with corruption.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====process_headers====<br /> <br /> $boolean = $crud-&gt;process_headers<br /> Process headers of CRUD request<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====$boolean====<br /> <br /> $boolean = $crud-&gt;( %opts )<br /> Generate SWORD error documents based on provided <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin_error====<br /> <br /> $boolean = $crud-&gt;plugin_error( $plugin, $messages )<br /> Generate error message for import <tt>$plugin</tt> used with <tt>$messages</tt> provided.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====send_response====<br /> <br /> $rc = $crud-&gt;send_response( $status, $content_type, $content )<br /> Output response to CRUD request with HTTP status code <tt>$status</tt>, content type <tt>$content_type</tt>.<br /> <br /> Returns HTTP response code <tt>OK</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> http://en.wikipedia.org/wiki/Create,_read,_update_and_delete<br /> <br /> http://en.wikipedia.org/wiki/Content_negotiation<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/CRUD&diff=15671 API:EPrints/Apache/CRUD 2023-03-15T15:13:15Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/CRUD.pm|package_name=EPrints::Apache::CRUD}}[[Category:API|CRUD]][[Category:API:EPrints/Apache|CRUD]]<div><br /> <br /> <br /> {{Version|since=3.3.0}}<br /> ==NAME==<br /> '''EPrints::Apache::CRUD''' - Create, read, update and delete via HTTP<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> $crud = EPrints::Apache::CRUD-&gt;new(<br /> repository =&gt; $repo,<br /> request =&gt; $r,<br /> datasetid =&gt; "eprint",<br /> dataobjid =&gt; "23",<br /> );<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> The CRUD (Create/Read/Update/Delete) module provides the Web API for manipulating content on the server. The API is an AtomPub implementation that exposes Import and Export plugins via simple URLs and HTTP content type negotiation.<br /> <br /> You should use the &lt;link&gt; entries in the repository's home page to locate the CRUD endpoint, as they may change in the future:<br /> <br /> &lt;link rel="Sword" href="https://myrepo/sword-app/servicedocument" /&gt;<br /> &lt;link rel="SwordDeposit" href="https://myrepo/id/contents" /&gt;<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Examples===<br /> Create a new eprint based on a single file:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Add a file to an existing eprint:<br /> <br /> curl -X POST \<br /> -i \<br /> -u user:password \<br /> -d 'Hello, World!' \<br /> -H 'Content-Disposition: attachment; filename=hello.txt' \<br /> -H 'Content-Type: text/plain' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 201 Created<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get an eprint's metadata in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> Get the list of contents (documents) of an eprint in Atom XML:<br /> <br /> curl -X GET \<br /> -i \<br /> -u user:password \<br /> -H 'Accept: application/atom+xml' \<br /> https://myrepo/id/eprint/23/contents<br /> <br /> HTTP/1.1 200 OK<br /> Content-Type: application/atom+xml;charset=utf-8<br /> ...<br /> <br /> You can find more examples in the ''tests/84_sword.t'' unit test.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===URI Layout===<br /> These URIs are relative to your EPrints HTTP/HTTPs root.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/contents GET,HEAD,OPTIONS,POST====<br /> <br /> Requires authentication.<br /> <br /> <tt>GET</tt> a list of the eprints owned by the user. <tt>POST</tt> to create a new EPrint object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid] DELETE,GET,HEAD,OPTIONS,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> an object's metadata or, for {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} objects, the file content. <tt>PUT</tt> to replace the metadata and/or contents (see [[API:EPrints/Apache/CRUD#Updating_complex_objects_using_PUT|Updating complex objects using PUT]]). If the object does not exist will attempt to create it with the given dataobjid (requires <tt>upsert</tt> privilege).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/[datasetid]/[dataobjid]/contents DELETE,GET,HEAD,OPTIONS,POST,PUT====<br /> <br /> Requires authentication depending on user's privileges and object visibility.<br /> <br /> <tt>GET</tt> the logical contents of the object: documents for eprints or files for documents. <tt>PUT</tt> to replace the existing contents or POST to add to the existing contents.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===HTTP Content Negotiation===<br /> <tt>GET</tt>/<tt>HEAD</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugins. <tt>POST</tt>/<tt>PUT</tt> requests are processed using {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugins.<br /> <br /> The plugin used depends on the request's <tt>Accept</tt> (<tt>GET</tt>/<tt>HEAD</tt>) or <tt>Content-Type</tt> (<tt>POST</tt>/<tt>PUT</tt>) header and the type of object being acted on. For example, the following request:<br /> <br /> GET /id/eprint/23 HTTP/1.1<br /> Accept: application/vnd.eprints.data+xml<br /> <br /> Will search for an Export plugin that accepts objects of type <tt>dataobj/eprint</tt> and can produce output in the MIME type <tt>application/vnd.eprints.data+xml</tt>. This will most likely be the {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} plugin.<br /> <br /> In addition to the general plugin negotiation behaviour some special cases are supported to improve compatibility with Atom Pub/Web Browser clients:<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/eprint/...====<br /> <br /> Requesting {{API:PodLink|file=EPrints/DataObj/EPrint|package_name=EPrints::DataObj::EPrint|section=|text=EPrint}} objects as text/html will result in a <tt>303 Redirect</tt> to the eprint object's abstract page or, if the eprint is not public, its {{API:PodLink|file=EPrints/Plugin/Screen/EPrint/View|package_name=EPrints::Plugin::Screen::EPrint::View|section=|text=View}} page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/document/.../contents====<br /> <br /> Requesting the <tt>/contents</tt> of a {{API:PodLink|file=EPrints/DataObj/Document|package_name=EPrints::DataObj::Document|section=|text=Document}} object will return the content of the document's main file.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====/id/file/...====<br /> <br /> Requesting a {{API:PodLink|file=EPrints/DataObj/File|package_name=EPrints::DataObj::File|section=|text=File}} object with no <tt>Accept</tt> header (or <tt>*/*</tt>) will return the file's content.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====POST /id/.../contents====<br /> <br /> When creating new records via POST, content negotiation is performed against the Import plugins.<br /> <br /> If no Import plugin supports the <em>Content-Type</em> header the content will be treated as <tt>application/octet-stream</tt> and stored in a new object. The resulting Atom entry will describe the new object (e.g. the <tt>eprint</tt> object in which the new <tt>document</tt> and <tt>file</tt> objects were created).<br /> <br /> Otherwise, the result will depend on the Import plugin's output. Import plugins may produce a single object, multiple objects or an object plus content file(s).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Type header====<br /> <br /> If no <tt>Content-Type</tt> header is given the MIME type defaults to <tt>application/octet-stream</tt> for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====Content-Disposition header====<br /> <br /> If the <tt>Content-Disposition</tt> header is missing or does not contain a <tt>filename</tt> parameter the filename defaults to ''main.bin'' for <tt>POST</tt>s and <tt>PUT</tt>s.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Updating complex objects using PUT===<br /> Eprint objects contain zero or more documents, which each contain zero or more files. When you update (<tt>PUT</tt>) an eprint object the contained documents will only be replaced if the Import plugin defines new documents e.g. the Atom Import plugin will never define new documents so <tt>PUT</tt>ing Atom content will only update the eprint's metadata. <tt>PUT</tt>ing {{API:PodLink|file=EPrints/Plugin/Export/XML|package_name=EPrints::Plugin::Export::XML|section=|text=EP3 XML}} will replace the documents if you include a <tt>&lt;documents</tt>&gt; XML element.<br /> <br /> <tt>PUT</tt>ing to <tt>/contents</tt> will always replace all contents - <tt>PUT</tt>ing to <tt>/eprint/23/contents</tt> is equivalent to <tt>DELETE /eprint/23/contents</tt> then <tt>POST /eprint/23/contents</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===PUT/DELETE from Javascript===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Upserting objects with PUT===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==CONSTANTS ==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_USER_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to user submitting content (i.e. ''/id/content'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATASET===<br /> <br /> Restrict the scope of the CRUD request to a dataset (i.e. ''/id/FOO...'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_DATAOBJ===<br /> <br /> Restrict the scope of the CRUD request to a data object (i.e. ''/id/FOO/BAR'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_FIELD===<br /> <br /> Restrict the scope of the CRUD request to a field of data object (i.e. ''/id/FOO/BAR/BAZ'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_CONTENTS===<br /> <br /> Restrict the scope of the CRUD request to the contents of data object (i.e. ''/id/FOO/BAR/contents'').<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===CRUD_SCOPE_SERVICEDOCUMENT===<br /> <br /> Restrict the scope of the CRUD request to the service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Constructor Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====new====<br /> <br /> $crud = EPrints::Apache::CRUD-&gt;new( %params )<br /> Return a new CRUD request using parameters given in <tt>%params</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===Object Methods===<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====repository====<br /> <br /> $repo = $crud-&gt;repository()<br /> Returns the current repository.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====request====<br /> <br /> $r = $crud-&gt;request()<br /> Returns the current {{API:PodLink|file=Apache2/RequestUtil|package_name=Apache2::RequestUtil|section=|text=Apache2::RequestUtil}}.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====method====<br /> <br /> $method = $crud-&gt;method()<br /> Returns the HTTP method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====scope====<br /> <br /> $scope = $crud-&gt;scope()<br /> Returns the scope of the action being performed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataset====<br /> <br /> $dataset = $crud-&gt;dataset()<br /> Returns the current dataset (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====dataobj====<br /> <br /> $dataobj = $crud-&gt;dataobj()<br /> Returns the current dataobj (if any).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====field====<br /> <br /> $field = $crud-&gt;field()<br /> Returns the current field (if available);<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====headers====<br /> <br /> $headers = $crud-&gt;headers()<br /> Get the processed headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====options====<br /> <br /> @verbs = $crud-&gt;options()<br /> Returns the available HTTP verbs for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin====<br /> <br /> $plugin = $crud-&gt;plugin()<br /> Returns the current plugin (if available).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_write====<br /> <br /> $bool = $crud-&gt;is_write()<br /> Returns <tt>true</tt> if the request is not a read-only method.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====accept_type====<br /> <br /> $accept_type = $crud-&gt;accept_type()<br /> Returns the EPrints type for the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====check_packaging====<br /> <br /> $rc = $crud-&gt;check_packaging()<br /> Check the Packaging header is ok, if given.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====resolve_relations====<br /> <br /> $dataobj = $crud-&gt;resolve_relations( $dataobj [, @relations ] )<br /> Resolve the relation path from <tt>$dataobj</tt> and return the resulting data object.<br /> <br /> Returns c&lt;undef&gt; if there is no such related object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authen====<br /> <br /> $rc = $crud-&gt;authen<br /> Returns HTTP code based of whether CRUD request can be authenticated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====authz====<br /> <br /> $rc = $crud-&gt;authz<br /> Returns HTTP code based of whether CRUD request can be authorized.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====parse_input====<br /> <br /> $list = $crud-&gt;parse_input( $plugin, $f [, %params ] )<br /> Parse the content submitted by the user using the given <tt>$plugin</tt>. <tt>$f</tt> is called by c&lt;epdata_to_dataobj&gt; to convert EPrints data markup to a data object. <tt>%params</tt> are passed to the plugin's <tt>input_fh</tt> method.<br /> <br /> Returns <tt>undef</tt> on error. Otherwise returns an [[API:EPrints/List|EPrints::List]] of data objects.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====create_dataobj====<br /> <br /> $dataobj = $crud-&gt;create_dataobj( $owner, $epdata )<br /> Creates data object as user $owner with metadata from $epdata<br /> <br /> Returns an [[API:EPrints/DataObj|EPrints::DataObj]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====import_plugins====<br /> <br /> @plugins = $crud-&gt;import_plugins( [ %params ] )<br /> Returns all matching import plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====export_plugins====<br /> <br /> @plugins = $crud-&gt;export_plugins( [ %params ] )<br /> Returns all matching export plugins against <tt>%params</tt> ordered by descending <tt>q</tt> score.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====content_negotiate_best_plugin====<br /> <br /> $plugin = $crud-&gt;content_negotiate_best_plugin()<br /> Work out the best plugin to export/update an object based on the client headers.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====crud====<br /> <br /> EPrints::Apache::CRUD( $media_range )<br /> Takes the <tt>$media_range</tt> string and returns array of acceptable MIME types. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 for more detail.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====handler====<br /> <br /> $rc = $crud-&gt;handler<br /> Handler of CRUD requests.<br /> <br /> Returns HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====delete====<br /> <br /> $rc = $crud-&gt;DELETE()<br /> Handle <tt>DELETE</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can't perform <tt>DELETE</tt> on ''/id/contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> No such object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_conflict====<br /> <br /> HTTP_CONFLICT<br /> Lock conflict with another user.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Successfully removed the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====get====<br /> <br /> $rc = $crud-&gt;GET( [ $owner ] )<br /> Handle <tt>GET</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> No sub-objects in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_acceptable====<br /> <br /> HTTP_NOT_ACCEPTABLE<br /> More than one sub-object in ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Export|package_name=EPrints::Plugin::Export|section=|text=Export}} plugin matches the <tt>Accept</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_see_other====<br /> <br /> HTTP_SEE_OTHER<br /> Redirect to a non-CRUD EPrints page.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_not_found====<br /> <br /> HTTP_NOT_FOUND<br /> Object not found.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_ok====<br /> <br /> HTTP_OK<br /> Object outputted successfully.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====post====<br /> <br /> $rc = $crud-&gt;POST( [ $owner ] )<br /> Handle <tt>POST</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_method_not_allowed====<br /> <br /> HTTP_METHOD_NOT_ALLOWED<br /> Can only POST to ''/id/.../contents''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_bad_request====<br /> <br /> HTTP_BAD_REQUEST<br /> No plugin for the SWORD <tt>Packaging</tt> header.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object(s) successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put====<br /> <br /> $rc = $crud-&gt;PUT( [ $owner ] )<br /> Handle <tt>PUT</tt> requests.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_unsupported_media_type====<br /> <br /> HTTP_UNSUPPORTED_MEDIA_TYPE<br /> No {{API:PodLink|file=EPrints/Plugin/Import|package_name=EPrints::Plugin::Import|section=|text=Import}} plugin matched the <tt>Content-Type</tt> header/object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_range_not_satisfiable====<br /> <br /> HTTP_RANGE_NOT_SATISFIABLE<br /> <tt>Range</tt> header is invalid or unsupported for the object type.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_forbidden====<br /> <br /> HTTP_FORBIDDEN<br /> User does not have permission to create/update the object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_created====<br /> <br /> HTTP_CREATED<br /> Object was successfully created.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====http_no_content====<br /> <br /> HTTP_NO_CONTENT<br /> Object was successfully updated.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====put_contents====<br /> <br /> $rc = $crud-&gt;PUT_contents( [ $owner ] )<br /> Equivalent to <tt>DELETE /id/.../contents</tt> then <tt>POST /id/.../contents</tt>.<br /> <br /> See [[API:EPrints/Apache/CRUD#DELETE|DELETE]] and [[API:EPrints/Apache/CRUD#POST|POST]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====metadata_relevant====<br /> <br /> $crud-&gt;metadata_relevant( $file )<br /> Test and if suitable use <tt>$file</tt> as metadata source to update the associated [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]].<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====servicedocument====<br /> <br /> $crud-&gt;servicedocument<br /> Generate response containing CRUD service document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====on_behalf_of====<br /> <br /> $rc = $crud-&gt;on_behalf_of( $user )<br /> Submit CRUD request on behalf of another user.<br /> <br /> Returns HTTPS response code based on whether request on behalf of is permitted.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_true====<br /> <br /> $boolean = EPrints::Apache::Crud::is_true( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>true</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_false====<br /> <br /> $boolean = EPrints::Apache::Crud::is_false( $header )<br /> Tests if <tt>$header</tt> attribute is <tt>false</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====is_file_ok====<br /> <br /> $boolean = $crud-&gt;is_file_ok( $epdata )<br /> Tests if files with <tt>$epdata</tt> were uploaded with corruption.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====process_headers====<br /> <br /> $boolean = $crud-&gt;process_headers<br /> Process headers of CRUD request<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====$boolean====<br /> <br /> $boolean = $crud-&gt;( %opts )<br /> Generate SWORD error documents based on provided <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====plugin_error====<br /> <br /> $boolean = $crud-&gt;plugin_error( $plugin, $messages )<br /> Generate error message for import <tt>$plugin</tt> used with <tt>$messages</tt> provided.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====generate_error_document====<br /> <br /> $error_document = EPrints::Apache::Crud::generate_error_document( $repo, %opts )<br /> Return error document for [[API:EPrints/Repository|EPrints::Repository]] <tt>$repo</tt> using options from <tt>%opts</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ====send_response====<br /> <br /> $rc = $crud-&gt;send_response( $status, $content_type, $content )<br /> Output response to CRUD request with HTTP status code <tt>$status</tt>, content type <tt>$content_type</tt>.<br /> <br /> Returns HTTP response code <tt>OK</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SEE ALSO==<br /> http://en.wikipedia.org/wiki/Create,_read,_update_and_delete<br /> <br /> http://en.wikipedia.org/wiki/Content_negotiation<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/Auth&diff=15670 API:EPrints/Apache/Auth 2023-03-15T12:42:11Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/Auth.pm|package_name=EPrints::Apache::Auth}}[[Category:API|AUTH]][[Category:API:EPrints/Apache|AUTH]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::Auth''' - Password authentication &amp; authorisation checking for EPrints.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This module handles the authentication and authorisation of users viewing private sections of an EPrints website.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===authen===<br /> <br /> $rc = EPrints::Apache::Auth::authen( $r, [ $realm ] )<br /> Perform authentication on request <tt>$r</tt>. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well.<br /> <br /> Returns a HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===authen_doc===<br /> <br /> $rc = EPrints::Apache::Auth::authen_doc( $r, [ $realm ] )<br /> Perform authentication on request <tt>$r</tt> for a document. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well.<br /> <br /> Returns a HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===auth_cookie===<br /> <br /> $rc = EPrints::Apache::Auth::auth_cookie( $r, $repository )<br /> Perform authentication by cookie on request S!$r! for repository <tt>$repository</tt>. Redirect as appropriate.<br /> <br /> Returns a HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===auth_basic===<br /> <br /> $rc = EPrints::Apache::Auth::auth_basic( $r, $repository, [ $realm ] )<br /> Perform authentication by basic authentication on request <tt>$r</tt> for repository <tt>$repository</tt>. If using <tt>auth_basic</tt> then include <tt>$realm</tt> as well.<br /> <br /> Returns a HTTP response code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===authz===<br /> <br /> $rc = EPrints::Apache::Auth::authz( $r )<br /> Perform authorization of request <tt>$r</tt>.<br /> <br /> Returns a HTTP response code (always <tt>200 OK</tt>).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===authz===<br /> <br /> $rc = EPrints::Apache::Auth::authz( $r )<br /> Perform authorization of request <tt>$r</tt> for a document.<br /> <br /> Returns a HTTP response code<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/AnApache&diff=15669 API:EPrints/Apache/AnApache 2023-03-15T12:33:55Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/AnApache.pm|package_name=EPrints::Apache::AnApache}}[[Category:API|ANAPACHE]][[Category:API:EPrints/Apache|ANAPACHE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::AnApache''' - Utility methods for talking to mod_perl<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This module provides a number of utility methods for interacting with the request object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==CONSTANTS==<br /> For backwards compatibility - use <tt>HTTP_</tt> constants instead of <tt>:common</tt> constants.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===AUTH_REQUIRED===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_UNAUTHORIZED</tt>. Authorization is required to access the requested resource.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===FORBIDDEN ===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_FORBIDDEN</tt>. Access to the requested resource is forbidden.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===SERVER_ERROR===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_INTERNAL_SERVER_ERROR</tt>. Requesting the resource has caused an internal server error.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_http_header===<br /> <br /> EPrints::Apache::AnApache::send_http_header( $request )<br /> Send the HTTP header, if needed.<br /> <br /> <tt>$request</tt> is the current Apache request. <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===header_out===<br /> <br /> EPrints::Apache::AnApache::header_out( $request, $header, $value )<br /> Set a value in the HTTP headers of the response. <tt>$request</tt> is the apache request object, <tt>$header</tt> is the name of the header and <tt>$value</tt> is the value to give that header.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===header_in===<br /> <br /> $value = EPrints::Apache::AnApache::header_in( $request, $header )<br /> Return the specified HTTP header from the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===$request===<br /> <br /> $request = EPrints::Apache::AnApache::get_request<br /> Return the current Apache request object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===cookie===<br /> <br /> $value = EPrints::Apache::AnApache::cookie( $request, $cookieid )<br /> Return the value of the named cookie, or undef if it is not set.<br /> <br /> This avoids using CGI, so does not consume the POST data.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===upload_doc_file===<br /> <br /> EPrints::Apache::AnApache::upload_doc_file( $session, $document, $paramid );<br /> Collect a file named $paramid uploaded via HTTP and add it to the specified <tt>$document</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===upload_doc_archive===<br /> <br /> EPrints::Apache::AnApache::upload_doc_archive( $session, $document, $paramid, $archive_format );<br /> Collect an archive file (.ZIP, .tar.gz, etc.) uploaded via HTTP and unpack it then add it to the specified document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_status_line===<br /> <br /> EPrints::Apache::AnApache::send_status_line( $request, $code, $message )<br /> Send a HTTP status to the client with <tt>$code</tt> and <tt>$message</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_hidden_status_line===<br /> <br /> EPrints::Apache::AnApache::send_hidden_status_line( $request, $code )<br /> Send a hidden HTTP status to the client with $code.<br /> <br /> This is intended for where EPrints already displays a useful error message but a 200 HTTP status code is otherwise logged.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===ranges===<br /> <br /> $rc = EPrints::Apache::AnApache::ranges( $r, $maxlength, $chunks )<br /> Populates the byte-ranges in $chunks requested by the client.<br /> <br /> <tt>$maxlength</tt> is the length, in bytes, of the resource.<br /> <br /> Returns the appropriate byte-range result code or <tt>OK</tt> if no <tt>Range</tt> header is set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/AnApache&diff=15668 API:EPrints/Apache/AnApache 2023-03-15T12:07:31Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/AnApache.pm|package_name=EPrints::Apache::AnApache}}[[Category:API|ANAPACHE]][[Category:API:EPrints/Apache|ANAPACHE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''EPrints::Apache::AnApache''' - Utility methods for talking to mod_perl<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This module provides a number of utility methods for interacting with the request object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==CONSTANTSFor backwards compatibility - use <tt>HTTP_</tt> constants instead of <tt>:common</tt> constants.==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===AUTH_REQUIRED===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_UNAUTHORIZED</tt>. Authorization is required to access the requested resource.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===FORBIDDEN ===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_FORBIDDEN</tt>. Access to the requested resource is forbidden.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===SERVER_ERROR===<br /> <br /> Maps to <tt>EPrints::Const::HTTP_INTERNAL_SERVER_ERROR</tt>. Requesting the resource has caused an internal server error.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_http_header===<br /> <br /> EPrints::Apache::AnApache::send_http_header( $request )<br /> Send the HTTP header, if needed.<br /> <br /> <tt>$request</tt> is the current Apache request. <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===header_out===<br /> <br /> EPrints::Apache::AnApache::header_out( $request, $header, $value )<br /> Set a value in the HTTP headers of the response. <tt>$request</tt> is the apache request object, <tt>$header</tt> is the name of the header and <tt>$value</tt> is the value to give that header.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===header_in===<br /> <br /> $value = EPrints::Apache::AnApache::header_in( $request, $header )<br /> Return the specified HTTP header from the current request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===$request===<br /> <br /> $request = EPrints::Apache::AnApache::get_request<br /> Return the current Apache request object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===cookie===<br /> <br /> $value = EPrints::Apache::AnApache::cookie( $request, $cookieid )<br /> Return the value of the named cookie, or undef if it is not set.<br /> <br /> This avoids using CGI, so does not consume the POST data.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===upload_doc_file===<br /> <br /> EPrints::Apache::AnApache::upload_doc_file( $session, $document, $paramid );<br /> Collect a file named $paramid uploaded via HTTP and add it to the specified <tt>$document</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===upload_doc_archive===<br /> <br /> EPrints::Apache::AnApache::upload_doc_archive( $session, $document, $paramid, $archive_format );<br /> Collect an archive file (.ZIP, .tar.gz, etc.) uploaded via HTTP and unpack it then add it to the specified document.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_status_line===<br /> <br /> EPrints::Apache::AnApache::send_status_line( $request, $code, $message )<br /> Send a HTTP status to the client with <tt>$code</tt> and <tt>$message</tt>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_hidden_status_line===<br /> <br /> EPrints::Apache::AnApache::send_hidden_status_line( $request, $code )<br /> Send a hidden HTTP status to the client with $code.<br /> <br /> This is intended for where EPrints already displays a useful error message but a 200 HTTP status code is otherwise logged.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===ranges===<br /> <br /> $rc = EPrints::Apache::AnApache::ranges( $r, $maxlength, $chunks )<br /> Populates the byte-ranges in $chunks requested by the client.<br /> <br /> <tt>$maxlength</tt> is the length, in bytes, of the resource.<br /> <br /> Returns the appropriate byte-range result code or <tt>OK</tt> if no <tt>Range</tt> header is set.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:tools/console&diff=15637 API:tools/console 2023-01-26T14:56:16Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=tools/console.pm|package_name=tools/console}}[[Category:API|TOOLS/CONSOLE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''console''' - Provides a console-based REPL to an EPrints archive<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''console''' [<em>repository_id</em>]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This script loads the specified archive and starts a REPL (Read-Eval-Print Loop) on the console so that you can interact with the repository directly. The repository session is available using the <tt>$session</tt> variable.<br /> <br /> If there is only one archive then the archive name is optional.<br /> <br /> This script requires the {{API:PodLink|file=Reply|package_name=Reply|section=|text=Reply}} module.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15636 API:bin/unit tests 2023-01-26T14:56:00Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15635 API:bin/unit tests 2023-01-26T14:55:35Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]][[Category:API:bin/unit_tests|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15634 API:bin/unit tests 2023-01-26T14:54:37Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15633 API:bin/unit tests 2023-01-26T14:49:26Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]][[Category:API:bin/unit_tests|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15632 API:bin/unit tests 2023-01-26T14:47:18Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]][[Category:API:bin/unit_tests|BIN/UNIT_TESTS]][[Category:API:bin/unit_tests|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/unit_tests&diff=15631 API:bin/unit tests 2023-01-26T14:46:41Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=bin/unit_tests.pm|package_name=bin/unit_tests}}[[Category:API|BIN/UNIT_TESTS]][[Category:API:bin/unit_tests|BIN/UNIT_TESTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''unit_tests''' - Unit testing for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''check_xapian''' <em>repository_id</em> ['''options'''] <br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> <em>To be written</em>.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--force'''===<br /> <br /> Ignore warnings and run anyway.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:tools/console&diff=15625 API:tools/console 2023-01-26T14:23:09Z

<p>Pod2wiki: Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=tools/console.pm|package_name=tools/console}}[[Category:API|TOOLS/CONSOLE]][[Category:API:tools/console|TOOLS/CONSOLE]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''console''' - Provides a console-based REPL to an EPrints archive<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''console''' [<em>repository_id</em>]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This script loads the specified archive and starts a REPL (Read-Eval-Print Loop) on the console so that you can interact with the repository directly. The repository session is available using the <tt>$session</tt> variable.<br /> <br /> If there is only one archive then the archive name is optional.<br /> <br /> This script requires the {{API:PodLink|file=Reply|package_name=Reply|section=|text=Reply}} module.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/generate_abstracts&diff=15438 API:bin/generate abstracts 2022-07-06T10:39:17Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_abstracts.pm|package_name=bin/generate_abstracts}}[[Category:API|BIN/GENERATE_ABSTRACTS]][[Category:API:bin/generate_abstracts|BIN/GENERATE_ABSTRACTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''generate_abstracts''' - Regenerate all the static abstract pages for an EPrint repository<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em>eprint_id</em>, <em>eprint_id</em>, <em>eprint_id</em>-<em>eprint_id</em> ...]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This script recreates every static abstract page for an eprints repository. To save load on the database, as archived data should not change, EPrints creates static webpages containing the summary of each eprint. If you change the way the abstracts are rendered or change the site template then you will want to run this script.<br /> <br /> To only recreate static abstract pages for certain eprint IDs provide a space separated list of eprint ID integer values. To recreate a tranche of consecutive eprint static abstract pages, use a hyphen between integer values, (e.g. 10-20).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''eprint_id''' ===<br /> <br /> An optional integer indicating that the static abstract page for eprint record <em>eprint_id</em> should be updated. Multiple <em>eprint_id</em> integer values may be provided to regenerate a set of static abstract pages for the specified eprints. To recreate a tranche of consecutive eprint static abstracts pages use a hyphen between integer values, (e.g. 10-20).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> Be vewwy vewwy quiet. This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on. May be repeated for greater effect.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki https://wiki.eprints.org/w/index.php?title=API:bin/generate_abstracts&diff=15437 API:bin/generate abstracts 2022-07-06T10:39:05Z

<p>Pod2wiki: </p> <hr /> <div>{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_abstracts.pm|package_name=bin/generate_abstracts}}[[Category:API|BIN/GENERATE_ABSTRACTS]][[Category:API:bin/generate_abstracts|BIN/GENERATE_ABSTRACTS]][[Category:API:bin/generate_abstracts|BIN/GENERATE_ABSTRACTS]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> '''generate_abstracts''' - Regenerate all the static abstract pages for an EPrint repository<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==SYNOPSIS==<br /> '''generate_abstracts''' <em>repository_id</em> ['''options'''] [<em>eprint_id</em>, <em>eprint_id</em>, <em>eprint_id</em>-<em>eprint_id</em> ...]<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> This script recreates every static abstract page for an eprints repository. To save load on the database, as archived data should not change, EPrints creates static webpages containing the summary of each eprint. If you change the way the abstracts are rendered or change the site template then you will want to run this script.<br /> <br /> To only recreate static abstract pages for certain eprint IDs provide a space separated list of eprint ID integer values. To recreate a tranche of consecutive eprint static abstract pages, use a hyphen between integer values, (e.g. 10-20).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==ARGUMENTS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''repository_id''' ===<br /> <br /> The ID of the eprint repository to use.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''eprint_id''' ===<br /> <br /> An optional integer indicating that the static abstract page for eprint record <em>eprint_id</em> should be updated. Multiple <em>eprint_id</em> integer values may be provided to regenerate a set of static abstract pages for the specified eprints. To recreate a tranche of consecutive eprint static abstracts pages use a hyphen between integer values, (e.g. 10-20).<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==OPTIONS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--help'''===<br /> <br /> Print a brief help message and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--man'''===<br /> <br /> Print the full manual page and then exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--quiet'''===<br /> <br /> Be vewwy vewwy quiet. This option will suppress all output unless an error occurs.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--verbose'''===<br /> <br /> Explain in detail what is going on. May be repeated for greater effect.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==='''--version'''===<br /> <br /> Output version information and exit.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki