Difference between revisions of "API:EPrints/MetaField"
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <!-- Pod2Wiki=_preamble_ | |
| + | This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
| + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/MetaField.pm|package_name=EPrints::MetaField}}[[Category:API|METAFIELD]][[Category:API:EPrints/MetaField|METAFIELD]]<div><!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
| + | ==NAME== | ||
| + | EPrints::MetaField - A single metadata field. | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_synopsis --> | ||
| + | ==SYNOPSIS== | ||
| + | <source lang="perl">my $field = $dataset->field( $fieldname ); | ||
| + | $dataset = $field->dataset; | ||
| + | $repo = $field->repository; | ||
| + | $field->set_property( $property, $value ); | ||
| + | $value = $field->property( $property ); | ||
| + | $name = $field->name; | ||
| + | $type = $field->type; | ||
| + | $xhtml = $field->render_name; | ||
| + | $xhtml = $field->render_help; | ||
| + | $xhtml = $field->render_value_label( $value ); | ||
| + | $values = $field->all_values( %opts ); | ||
| + | $sorted_list = $field->sort_values( $unsorted_list );</source> | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_description --> | ||
| + | ==DESCRIPTION== | ||
| + | This object represents a single metadata field, not the value of that field. A field belongs (usually) to a dataset and has a large number of properties. Optional and required properties vary between types. | ||
| + | |||
| + | "type" is the most important property, it is the type of the metadata field. For example: "text", "name" or "date". | ||
| + | |||
| + | A full description of metadata types and properties is in the eprints documentation and will not be duplicated here. | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_properties --> | ||
| + | ==PROPERTIES== | ||
| + | * replace_core => 0 | ||
| + | : Normally any attempt to define two fields with the same name will fail. However, you can replace a core system field by specifying the "replace_core" property. This should be used very carefully! | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_rendering --> | ||
| + | ===Rendering=== | ||
| + | * render_value => CODEREF | ||
| + | <pre> sub my_render_method | ||
| + | { | ||
| + | my( $repo, $field, $value, $all_langs, $no_link, $object ) = @_; | ||
| + | |||
| + | return $repo->xml->create_text_node( $value ); | ||
| + | }</pre> | ||
| + | |||
| + | : Override the default rendering of values with a custom method. Renders $value (which may be a multiple) and returns an XHTML fragment. | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_read_only_properties --> | ||
| + | ===Read-only Properties=== | ||
| + | * provenance => "core" or "config" | ||
| + | : Indiciates where the field was initialised from. "core" fields are defined in {{API:PodLink|file=DataObj|package_name=DataObj|section=|text=DataObj}} classes while "config" fields are defined in cfg.d files. | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=head_methods --> | ||
| + | ==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 --> | ||
| + | ==COPYRIGHT== | ||
| + | Copyright 2000-2011 University of Southampton. | ||
| + | |||
| + | This file is part of EPrints http://www.eprints.org/. | ||
| + | |||
| + | EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | ||
| + | |||
| + | EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. | ||
| + | |||
| + | You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/. | ||
| + | |||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | <!-- Pod2Wiki=_postamble_ --> | ||
| + | <!-- Edit below this comment --> | ||
Latest revision as of 09:44, 11 May 2012
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::MetaField - A single metadata field.
SYNOPSIS
my $field = $dataset->field( $fieldname );
$dataset = $field->dataset;
$repo = $field->repository;
$field->set_property( $property, $value );
$value = $field->property( $property );
$name = $field->name;
$type = $field->type;
$xhtml = $field->render_name;
$xhtml = $field->render_help;
$xhtml = $field->render_value_label( $value );
$values = $field->all_values( %opts );
$sorted_list = $field->sort_values( $unsorted_list );
DESCRIPTION
This object represents a single metadata field, not the value of that field. A field belongs (usually) to a dataset and has a large number of properties. Optional and required properties vary between types.
"type" is the most important property, it is the type of the metadata field. For example: "text", "name" or "date".
A full description of metadata types and properties is in the eprints documentation and will not be duplicated here.
PROPERTIES
- replace_core => 0
- Normally any attempt to define two fields with the same name will fail. However, you can replace a core system field by specifying the "replace_core" property. This should be used very carefully!
Rendering
- render_value => CODEREF
sub my_render_method
{
my( $repo, $field, $value, $all_langs, $no_link, $object ) = @_;
return $repo->xml->create_text_node( $value );
}
- Override the default rendering of values with a custom method. Renders $value (which may be a multiple) and returns an XHTML fragment.
Read-only Properties
- provenance => "core" or "config"
- Indiciates where the field was initialised from. "core" fields are defined in DataObj classes while "config" fields are defined in cfg.d files.
METHODS
set_property
$field->set_property( $property, $value )
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.
repository
$repository = $field->repository
Return the EPrints::Repository to which this field belongs.
dataset
$dataset = $field->dataset
Return the EPrints::DataSet to which this field belongs, or undef.
render_name
$xhtml = $field->render_name
Render the name of this field as an XHTML object.
render_help
$xhtml = $field->render_help
Return the help information for a user inputing some data for this field as an XHTML chunk.
name
$name = $field->name
Return the name of this field.
type
$type = $field->type
Return the type of this field.
property
$value = $field->property( $property )
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.
sort_values
$out_list = $field->sort_values( $in_list, $langid )
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.
all_values
$values = $field->all_values( %opts )
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.
COPYRIGHT
Copyright 2000-2011 University of Southampton.
This file is part of EPrints http://www.eprints.org/.
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.
