Editing Template:EPrints Metadata Fields Content (section)

=== Object Methods ===
'''TO BE COMPLETED'''
{| cellpadding="3" cellspacing="0" border="1"
! Name !! Exemplar !!Parameters !! Returns !!  Description
|-
| '''field_defaults'''
||<code>$defaults = $field->field_defaults</code>
||
; $self : A <code>EPrints::MetaField</code> object.
||A hash reference of the default properties for the class of <code>EPrints::MetaField</code> of which this object is an instance.
||Provides the default properties of this <code>EPrints::MetaField</code> object.
|-
| '''final'''
||<code>$field->final</code>
|| 
; $self : A <code>EPrints::MetaField</code> object.
||n/a
||Tells the <code>EPrints::MetaField</code> that it is now read only. Any call to <code>set_property</code> will produce a abort error.
|-
| '''set_property'''
|| <code>$field->set_property( $property, $value )</code>
||
; $self : A <code>EPrints::MetaField</code> object.
; $property : The property to be set.
; $value : The value to set for the <code>$property</code>.
||n/a
||Tells the <code>EPrints::MetaField</code> that it is now read only. Any call to <code>set_property</code> will produce a abort error.
|-
| '''clone'''
|| <code>$newfield = $field->clone</code>
||
; $self : A <code>EPrints::MetaField</code> object.
||A new <code>EPrints::MetaField</code> object that is a clone of the existing object.
||Clone the field, so the clone can be edited without affecting the original. Does not deep copy properties which are references - these should be set to new values, rather than the contents altered. E.g. Don't push to a cloned options list, replace it.
|
|-
| '''repository'''
|| <code>$repository = $field->repository</code>
||
; $self : A <code>EPrints::MetaField</code> object.
|| The <code>EPrints::Repository</code> object to which this field belongs.
|| Get the current repository object.
|
|-
| '''dataset'''
|| <code>$dataset = $field->dataset</code> (or <code>$dataset = $field->get_dataset</code>)
||
; $self : A <code>EPrints::MetaField</code> object.
|| The <code>EPrints::DataSet</code> object to which this field belongs.
|| Get dataset to which this field belongs.
|-
| '''render_name'''
|| <code>$xhtml = $field->render_name( [ $session ], [ $dataobj] )</code>
||
; $self : A <code>EPrints::MetaField</code> object.
; $session :  A <code>EPrints::Repository</code> object. (No longer required but at least a placeholder required if specifying <code>$dataobj</code>).
; $dataobj : A data object belong to the <code>$dataset</code> that has the <code>$value</code> set for this field.  Only required if you want to use a bespoke phrase based on the type value for the data object, (e.g. <code><epp:phrase id="eprint_fieldname_data_type.dataset">...</epp:phrase></code>).
|| A <code>XML::LibXML::DocumentFragment</code> containing the help text for the field.
|| Get the help information for a user inputting some data for this field as an XHTML chunk.  Either from a phrase defined for the field or under the field property <code>help_xhtml</code>.
|-
| '''render_help'''
|| <code>$xhtml = $field->render_help</code>
||
; $self : A <code>EPrints::MetaField</code> object.
|| A <code>XML::LibXML::DocumentFragment</code> containing the help text for the field.
|| Get the help information for a user inputting some data for this field as an XHTML chunk.  Either from a phrase defined for the field or under the field property <code>help_xhtml</code>.
|-
| '''render_input_field'''
|| <code>$xhtml = $field->render_input_field( $session, $value, $dataset, $staff, $hidden_fields, $obj, $basename, $one_field_component )
</code>
||
; $self : A <code>EPrints::MetaField</code> object.
; $session :  A <code>EPrints::Repository</code> object.
; $value : The value from the database to be rendered within this field.
; $dataset : The <code>EPrints::Dataset</code> to which the field belongs. (Does not always need to be defined) 
; $staff : A boolean (typically <code>0</code> or <code>1</code>) for whether the but usually set to <code>0</code> as this should be managed through a conditional statement in the workflow.
; $hidden_fields : Extra fields associated with this field but rendered so they cannot be seen by the user (e.g. <code><input type="hidden" ... /></code>).
; $obj : A data object belong to the <code>$dataset</code> that has the <code>$value</code> set for this field.
; $basename : The basename for this field for uses as a prefix when a compound field that contains sub-fields.
; $one_field_component : A boolean (typically <code>0</code> or <code>1</code>) defining whether the workflow component that the field is being rendered has just this field or multiple fields in it.
|| A <code>XML::LibXML::DocumentFragment</code> containing an XHTML rendering of the field for input.
|| Get an XHTML rendering of the field for input.  May be overridden with <code>render_input</code> property for this field.
|}