TWikiAttachDotPm < TWiki

---+ Package =TWiki::Attach=

A singleton object of this class is used to deal with attachments to topics.


%TOC%

---++ ClassMethod *new* <tt>($session)</tt>

Constructor



---++ ObjectMethod *renderMetaData* <tt>($web,$topic,$meta,$args) -> $text</tt>

Generate a table of attachments suitable for the bottom of a topic
view, using templates for the header, footer and each row.
   * =$web= the web
   * =$topic= the topic
   * =$meta= meta-data hash for the topic
   * =$args= hash of attachment arguments



---++ ObjectMethod *formatVersions* <tt>($web,$topic,$attrs) -> $text</tt>

Generate a version history table for a single attachment
   * =$web= - the web
   * =$topic= - the topic
   * =$attrs= - Hash of meta-data attributes



---++ ObjectMethod *getAttachmentLink* <tt>($user,$web,$topic,$name,$meta) -> $html</tt>

   * =$user= - User doing the reading
   * =$web= - Name of the web
   * =$topic= - Name of the topic
   * =$name= - Name of the attachment
   * =$meta= - Meta object that contains the meta info

Build a link to the attachment, suitable for insertion in the topic.



---++ ObjectMethod *migrateToFileAttachmentMacro* <tt>($meta,$text) -> $text</tt>

Migrate old HTML format



---++ ObjectMethod *upgradeFrom1v0beta* <tt>($meta) -> $text</tt>

CODE_SMELL: Is this really necessary? upgradeFrom1v0beta?

This topic: TWiki > TWikiAttachDotPm
Topic revision: r2 - 2007-01-16 - TWikiContributor

Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiAttachDotPm.