Editing API:EPrints/DataObj/MetaField (section)

===Object 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_get_property_defaults -->
====get_property_defaults====

 $defaults = $metafield-&gt;get_property_defaults( $repo, $type )
Gets the property defaults for metafield <tt>$type</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_dump -->
====dump====

 $str = $metafield-&gt;dump
Dump the fields configuration as used in <tt>cfg.d</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_get_parent_id -->
====get_parent_id====

 $parent = $metafield-&gt;get_parent_id
Returns the parent ID for this metafield.

Alias for:

 $metafield-&gt;value( "parent" );
  
<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_remove -->
====remove====

 $ok = $metafield-&gt;remove
Remove the field and any sub-fields from the database.

<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_config_path -->
====config_path====

 $path = $metafield-&gt;config_path
Returns the root directory of the repository configuration path.

<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_config_filename -->
====config_filename====

 $filename = $metafield-&gt;config_filename( $dataset )
Returns the location of the cfg.d config file for the provided <tt>$dataset</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_phrases_filename -->
====phrases_filename====

 $filename = $metafield-&gt;phrases_filename( $langid )
Returns the location of the XML phrases file for provided <tt>$lang</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_workflow_filename -->
====workflow_filename====

 $filename = $metafield-&gt;workflow_filename( $dataset )
Returns the location of the workflow file for the provided  <tt>$dataset</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_add_to_phrases -->
====add_to_phrases====

 $ok = $metafield-&gt;add_to_phrases
Adds the phrases defined by this metafield to the system.

<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_remove_from_dataset -->
====remove_from_dataset====

 $ok = $metafield-&gt;remove_from_dataset
Remove this metafield from the dataset specified by its <tt>mfdatasetid</tt> value.

Returns boolean dependent on success removing from the dataset.

<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_add_to_database -->
====add_to_database====

 $ok = $metafield-&gt;add_to_database
Add this metafield to the database.

Returns boolean dependent on success adding to the database.

<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_remove_from_database -->
====remove_from_database====

 $ok = $metafield-&gt;remove_from_database
Remove this field from the database.

Returns boolean dependent on success removing from the database.

<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_add_to_workflow -->
====add_to_workflow====

 $ok = $metafield-&gt;add_to_workflow
Add this metafield to the workflow in the <tt>Misc.</tt> section.

Returns boolean dependent on success adding to the workflow.

<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_remove_from_workflow -->
====remove_from_workflow====

 $ok = $metafield-&gt;remove_from_workflow
Remove all occurrences of this field from the workflow. Will remove  the <tt>local</tt> stage if it is empty.

Returns boolean dependent on success removing from the workflow.

<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_perl_struct -->
====perl_struct====

 $data = $metafield-&gt;perl_struct( $prefix )
Returns the Perl data structure representation of this field, as you  would find defined in the configuration or [[API:EPrints/DataObj|EPrints::DataObj]]  classes.

If <tt>$prefix</tt> is defined returns the Perl data structure for the  fields property, where <tt>$prefix</tt> is the fieldname of the parent  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_make_field_object -->
====make_field_object====

 $field = $metafield-&gt;make_field_object
Makes and returns a new field object based on this metafield.

<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_add_to_repository -->
====add_to_repository====

 $ok = $metafield-&gt;add_to_repository
Adds this field to the repository.

Returns boolean dependent on success adding to the repository.

<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_remove_from_repository -->
====remove_from_repository====

 $ok = $mf-&gt;remove_from_repository
Remove this field from the repository.

Returns boolean dependent on success removing from the repository.

<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_validate -->
====validate====

 $problems = $metafield-&gt;validate( $repository )
Returns any problems associated with this metafield as an array  reference.

<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_citation -->
====render_citation====

 $xhtml = $metafield-&gt;render_citation( [ $type, %params ] )
Returns a XHTML DOM rendering of the metafield using citation  <tt>$type</tt> (of <tt>default</tt> if not provided) an specified <tt>%params</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=head_see_also -->