Difference between revisions of "API:EPrints/MetaField/Base64"

From EPrints Documentation
Jump to: navigation, search
 
Line 28: Line 28:
 
<!-- Pod2Wiki=head_inheritance -->
 
<!-- Pod2Wiki=head_inheritance -->
 
==INHERITANCE==
 
==INHERITANCE==
  {{API:PodLink|file=EPrints/MetaField|package_name=EPrints::MetaField|section=|text=MetaField}}
+
  [[API:EPrints/MetaField|EPrints::MetaField]]
   {{API:PodLink|file=EPrints/MetaField/Text|package_name=EPrints::MetaField::Text|section=|text=Text}}
+
   [[API:EPrints/MetaField/Text|EPrints::MetaField::Text]]
     {{API:PodLink|file=EPrints/MetaField/Longtext|package_name=EPrints::MetaField::Longtext|section=|text=Longtext}}
+
     [[API:EPrints/MetaField/Longtext|EPrints::MetaField::Longtext]]
       Base64
+
       '''EPrints::MetaField::Base64'''
 
    
 
    
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Latest revision as of 17:13, 20 March 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

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


NAME

EPrints::MetaField::Base64 - Base 64 encoded data

User Comments


DESCRIPTION

Data encoded in base64. This may be small files (e.g. kilobytes) better save in the database rather than to the filesystem.

User Comments


INHERITANCE

EPrints::MetaField
  EPrints::MetaField::Text
    EPrints::MetaField::Longtext
      EPrints::MetaField::Base64
 

User Comments


PROPERTIES

To be written

User Comments


METHODS

User Comments


form_value

$value = $field->form_value( $session, $object, [$prefix] )

Base64 encode the CGI parameter submitted within the form for this particular field. Assuming the from contained such an input field.

Returns a single scalar or array of base64 encoded values.

User Comments


to_sax

$xml = $field->to_sax( $value, %opts )

Print the field and value(s) as an XML representation of a base64 field.

User Comments


get_xml_schema_type

$type = $field->get_xml_schema_type

Gets the XML schema type for this base64 field.

Returns a string containing the type, dataset ID and and name of this field (e.g. base64_file_data).

User Comments


render_xml_schema_type

$type = $field->render_xml_schema_type

Produces an XML fragment this base64 field.

Returns a DOM for the following:

<xs:complexType name="base64_file_data">
  <xs:simpleContent>
    <xs:extension base="xs:base64Binary">
      <xs:attribute name="encoding">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="base64" />
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:extension>
  </xs:simpleContent>
</xs:complexType>
 

E.g., <data encoding="base64">...</data>

User Comments


COPYRIGHT

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

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.

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.

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/.

User Comments