|
|
| Line 1: |
Line 1: |
| <!-- Pod2Wiki=_preamble_
| |
| This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
| |
| -->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/MetaField.pm|package_name=EPrints::DataObj::MetaField}}[[Category:API|MetaField]]<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_name -->=NAME=
| |
| '''EPrints::DataObj::MetaField''' - metadata fields
| |
|
| |
|
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_description -->=DESCRIPTION=
| |
| This is an internal class that shouldn't be used outside [[API:EPrints/Database|EPrints::Database]].
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_methods -->=METHODS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
| |
|
| |
| $thing = EPrints::DataObj::MetaField->get_system_field_info
| |
|
| |
| Core fields.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new -->===new===
| |
|
| |
| $thing = EPrints::DataObj::MetaField->new( $session, $metafieldid )
| |
|
| |
| The data object identified by $metafieldid.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new_from_data -->===new_from_data===
| |
|
| |
| $thing = EPrints::DataObj::MetaField->new_from_data( $session, $known )
| |
|
| |
| A new <tt>EPrints::DataObj::MetaField</tt> object containing data $known (a hash reference).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_perl_struct -->===get_perl_struct===
| |
|
| |
| $data = EPrints::DataObj::MetaField->get_perl_struct
| |
|
| |
| Returns the Perl data structure representation of this field, as you would find defined in the configuration or DataObj classes.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_class_methods -->==Class Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove_all -->===remove_all===
| |
|
| |
| EPrints::DataObj::MetaField::remove_all( $session )
| |
|
| |
| Remove all records from the metafield dataset.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_defaults -->===get_defaults===
| |
|
| |
| $defaults = EPrints::DataObj::MetaField->get_defaults( $session, $data )
| |
|
| |
| Return default values for this object based on the starting data.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_object_methods -->==Object Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove -->===remove===
| |
|
| |
| $foo = $thing->remove()
| |
|
| |
| Remove this record from the data set (see [[API:EPrints/Database|EPrints::Database]]).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove_from_workflow -->===remove_from_workflow===
| |
|
| |
| $ok = $mf->remove_from_workflow()
| |
|
| |
| Remove all occurrences of this field from the workflow. Will remove the "local" stage if it is empty.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_see_also -->=SEE ALSO=
| |
| [[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
| |
| {{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_add_to_phrases -->==add_to_phrases==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_add_to_workflow -->==add_to_workflow==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_commit -->==commit==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_destroy_field -->==destroy_field==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_config_file -->==get_config_file==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_config_path -->==get_config_path==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_field -->==get_field==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_perl_file_config -->==get_perl_file_config==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_valid_datasets -->==get_valid_datasets==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_warnings -->==get_warnings==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_xml_file_config -->==get_xml_file_config==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_load_all -->==load_all==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_move_to_archive -->==move_to_archive==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_move_to_deletion -->==move_to_deletion==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_move_to_inbox -->==move_to_inbox==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_save_all -->==save_all==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_validate -->==validate==
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
| |