Jump to content
Wiki Home
EPrints Home
Bazaar
Files
Main menu
Main menu
move to sidebar
hide
Navigation
Front Page
EPrints 3 Manual
EPrints Training Course
EPrints Glossary
Installing EPrints
How-to Configure EPrints
EPrints 3.2+ API
EPrints 3 Reference
EPrints Plugins
Wiki
All categories
Recent changes
Main Page
Help
EPrints Documentation
Search
Search
Appearance
Log in
Request account
Personal tools
Log in
Request account
Pages for logged out editors
learn more
Contributions
Talk
Editing
API:EPrints/MetaField
(section)
Page
Discussion
British English
Read
Edit
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
==METHODS== <!-- Pod2Wiki=head_set_property --> ===set_property=== <source lang="perl">$field->set_property( $property, $value ) </source> Set the named property to the given value. This should not be called on metafields unless they've been cloned first. This method will cause an abort error if the metafield is read only. In these cases a cloned version of the field should be used. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_repository --> ===repository=== <source lang="perl">$repository = $field->repository </source> Return the [[API:EPrints/Repository|EPrints::Repository]] to which this field belongs. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_dataset --> ===dataset=== <source lang="perl">$dataset = $field->dataset </source> Return the [[API:EPrints/DataSet|EPrints::DataSet]] to which this field belongs, or undef. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_render_name --> ===render_name=== <source lang="perl">$xhtml = $field->render_name </source> Render the name of this field as an XHTML object. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_render_help --> ===render_help=== <source lang="perl">$xhtml = $field->render_help </source> Return the help information for a user inputing some data for this field as an XHTML chunk. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_name --> ===name=== <source lang="perl">$name = $field->name </source> Return the name of this field. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_type --> ===type=== <source lang="perl">$type = $field->type </source> Return the type of this field. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_property --> ===property=== <source lang="perl">$value = $field->property( $property ) </source> Return the value of the given property. Special note about "required" property: It only indicates if the field is always required. You must query the dataset to check if it is required for a specific type. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_sort_values --> ===sort_values=== <source lang="perl">$out_list = $field->sort_values( $in_list, $langid ) </source> Sorts the in_list into order, based on the "order values" of the values in the in_list. Assumes that the values are not a list of multiple values. [ [], [], [] ], but rather a list of single values. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_all_values --> ===all_values=== <source lang="perl">$values = $field->all_values( %opts ) </source> Return a reference to an array of all the values of this field. For fields like "subject" or "set" it returns all the variations. For fields like "text" return all the distinct values from the database. Results are sorted according to the ordervalues of the current session. <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Edit below this comment --> <!-- Pod2Wiki= --> <!-- Pod2Wiki=head_copyright -->
Summary:
Please note that all contributions to EPrints Documentation may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
EPrints Documentation:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)