View source for API:EPrints/MetaField/Base64

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/MetaField/Base64.pm|package_name=EPrints::MetaField::Base64}}[[Category:API|BASE64]][[Category:API:EPrints/MetaField|BASE64]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''EPrints::MetaField::Base64''' - Base 64 encoded data

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
Data encoded in base64.  This may be small files (e.g. kilobytes)  better save in the database rather than to the filesystem.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_inheritance -->
==INHERITANCE==
 [[API:MetaField|EPrints::MetaField]]
   [[API:Text|EPrints::MetaField::Text]]
     [[API:Longtext|EPrints::MetaField::Longtext]]
       Base64
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_properties -->
==PROPERTIES==
<em>To be written</em>

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_methods -->
==METHODS==
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_form_value -->
===form_value===

 $value = $field-&gt;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.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_to_sax -->
===to_sax===

 $xml = $field-&gt;to_sax( $value, %opts )
Print the field and value(s) as an XML representation of a base64  field.

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_xml_schema_type -->
===get_xml_schema_type===

 $type = $field-&gt;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. <tt>base64_file_data</tt>).

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_render_xml_schema_type -->
===render_xml_schema_type===

 $type = $field-&gt;render_xml_schema_type
Produces an XML fragment this base64 field.

Returns a DOM for the following:

 &lt;xs:complexType name="base64_file_data"&gt;
   &lt;xs:simpleContent&gt;
     &lt;xs:extension base="xs:base64Binary"&gt;
       &lt;xs:attribute name="encoding"&gt;
         &lt;xs:simpleType&gt;
           &lt;xs:restriction base="xs:string"&gt;
             &lt;xs:enumeration value="base64" /&gt;
           &lt;/xs:restriction&gt;
         &lt;/xs:simpleType&gt;
       &lt;/xs:attribute&gt;
     &lt;/xs:extension&gt;
   &lt;/xs:simpleContent&gt;
 &lt;/xs:complexType&gt;
  
E.g., &lt;data encoding="base64"&gt;...&lt;/data&gt;

<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
{{API:Copyright}}
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->