Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Package
All TWiki topics have data (text) and meta-data (information about the
topic). Meta-data includes information such as file attachments, form fields,
topic parentage etc. When TWiki loads a topic from the store, it represents
the meta-data in the topic using an object of this class.
A meta-data object is a hash of different types of meta-data (keyed on
the type, such as 'FIELD' and 'TOPICINFO').
Each entry in the hash is an array, where each entry in the array
contains another hash of the key=value pairs, corresponding to a
single meta-datum.
If there may be multiple entries of the same top-level type (i.e. for FIELD
and FILEATTACHMENT) then the array has multiple entries. These types
are referred to as "keyed" types. The array entries are keyed with the
attribute 'name' which must be in each entry in the array.
For unkeyed types, the array has only one entry.
Pictorially, | ||||||||
Added: | ||||||||
> > | ObjectMethod topicTitle ()Get/set the topic title. In order of sequence, the topic title is defined by: Form field named "Title", topic preference setting named TITLE, topic name. | |||||||
ObjectMethod text ([$text]) -> $textGet/set the topic body text. If $text is undef, gets the value, if it is defined, sets the value to that and returns the new text.ObjectMethod put ($type,\%args)Put a hash of key=value pairs into the given type set in this meta. This will not replace another value with the same name (for that seeputKeyed )
For example,
$meta->put( 'FIELD', { name => 'MaxAge', title => 'Max Age', value =>'103' } ); ObjectMethod putKeyed ($type,\%args)Put a hash of key=value pairs into the given type set in this meta, replacing any existing value with the same key. For example,$meta->putKeyed( 'FIELD', { name => 'MaxAge', title => 'Max Age', value =>'103' } ); ObjectMethod putAllReplaces all the items of a given key with a new array. For example,$meta->putAll( 'FIELD', { name => 'MinAge', title => 'Min Age', value =>'50' }, { name => 'MaxAge', title => 'Max Age', value =>'103' }, { name => 'HairColour', title => 'Hair Colour', value =>'white' } ); ObjectMethod get ($type,$key) -> \%hashFind the value of a meta-datum in the map. If the type is keyed (idenitifed by aname ), the $key parameter is required
to say which entry you want. Otherwise you will just get the first value.
If you want all the keys of a given type use the 'find' method.
The result is a reference to the hash for the item.
For example,
my $ma = $meta->get( 'FIELD', 'MinAge' ); my $topicinfo = $meta->get( 'TOPICINFO' ); # get the TOPICINFO hash ObjectMethod find ($type) -> @values
Get all meta data for a specific type.
Returns the array stored for the type. This will be zero length
if there are no entries.
For example,
my $attachments = $meta->find( 'FILEATTACHMENT' ); ObjectMethod remove ($type,$key)With no type, will remove all the contents of the object. With a $type but no $key, will remove all items of that type (so for example if $type were FILEATTACHMENT it would remove all of them) With a $type and a $key it will remove only the specific item.ObjectMethod copyFrom ($otherMeta,$type,$nameFilter)Copy all entries of a type from another meta data set. This will destroy the old values for that type, unless the copied object doesn't contain entries for that type, in which case it will retain the old values. If $type is undef, will copy ALL TYPES. If $nameFilter is defined (a perl refular expression), it will copy only data where{name} matches $nameFilter.
Does not copy web, topic or text.
ObjectMethod count ($type) -> $integerReturn the number of entries of the given typeObjectMethod getRevisionInfo ($fromrev) -> ($date,$author,$rev,$comment)Try and get revision info from the meta information, or, if it is not present, kick down to the Store module for the same information. Returns ( $revDate, $author, $rev, $comment ) $rev is an integer revision number.ObjectMethod merge ($otherMeta,$formDef)
ObjectMethod stringify ($types) -> $stringReturn a string version of the meta object. Uses \n to separate lines. If$types is specified, return only types
that match it. Types should be a perl regular expression.
ObjectMethod forEachSelectedValue ($types,$keys,\&fn,\%options)Iterate over the values selected by the regular expressions in $types and $keys.
\&fn on each, and replacing the value
with the result of \&fn.
\%options will be passed on to $fn, with the following additions:
ObjectMethod getParent () -> $parentGets the TOPICPARENT name.ObjectMethod getFormName () -> $formnameReturns the name of the FORM, or '' if none.ObjectMethod renderFormForDisplay () -> $htmlRender the form contained in the meta for display.ObjectMethod renderFormFieldForDisplay ($name,$format,$attrs) -> $textRender a single formfield, using the $format. See TWiki::Form::FormField::renderForDisplay for a description of how the value is rendered.ObjectMethod getEmbeddedStoreForm () -> $textGenerate the embedded store form of the topic. The embedded store form has meta-data values embedded using %META: lines. The text stored in the meta is taken as the topic text.ObjectMethod getMetaFor () -> $metaThis method will load (or otherwise fetch) the meta-data for a named web/topic. The request might be satisfied by a read from the store, or it might be satisfied from a cache. The caller doesn't care. This is an object method rather than a static method because it depends on the implementation of Meta - it might be this base class, or it might be a caching subclass, for example. |