TWiki/TWikiUIManageDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::UI::Manage="></a> Package =TWiki::UI::Manage
   2
   3 UI functions for web, topic and user management
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Package =TWiki::UI::Manage="> Package TWiki::UI::Manage</a><ul>
   8         <li><a href="#StaticMethod <strong>manage</strong> ($session)"> StaticMethod manage <tt>($session)</tt></a></li>
   9         <li><a href="#StaticMethod <strong>rename</strong> ($session)"> StaticMethod rename <tt>($session)</tt></a></li>
  10         <li><a href="#StaticMethod <strong>move</strong> ($session,$o"> StaticMethod move <tt>($session,$oldWeb,$oldTopic,$newWeb,$newTopic,$attachment,\@refs)</tt></a></li>
  11         <li><a href="#StaticMethod *get_ReferringTopic"> StaticMethod getReferringTopics <tt>($session,$web,$topic,$allWebs) -&gt; \%matches</tt></a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 ## <a name="StaticMethod &lt;strong&gt;manage&lt;/strong&gt; ($session)"></a> [[StaticMethod]] **manage** `($session)`
  18
  19 `manage` command handler. This method is designed to be invoked via the `UI::run` method.
  20
  21 ## <a name="StaticMethod &lt;strong&gt;rename&lt;/strong&gt; ($session)"></a> [[StaticMethod]] **rename** `($session)`
  22
  23 `rename` command handler. This method is designed to be invoked via the `UI::run` method. Rename the given topic. Details of the new topic name are passed in CGI parameters:
  24
  25 <table border="1" cellpadding="0" cellspacing="0">
  26   <tr>
  27     <td><code>skin</code></td>
  28     <td> skin(s) to use </td>
  29   </tr>
  30   <tr>
  31     <td><code>newweb</code></td>
  32     <td> new web name </td>
  33   </tr>
  34   <tr>
  35     <td><code>newtopic</code></td>
  36     <td> new topic name </td>
  37   </tr>
  38   <tr>
  39     <td><code>breaklock</code></td>
  40     <td>   </td>
  41   </tr>
  42   <tr>
  43     <td><code>attachment</code></td>
  44     <td>   </td>
  45   </tr>
  46   <tr>
  47     <td><code>confirm</code></td>
  48     <td> if defined, requires a second level of confirmation </td>
  49   </tr>
  50   <tr>
  51     <td><code>currentwebonly</code></td>
  52     <td> if defined, searches current web only for links to this topic </td>
  53   </tr>
  54   <tr>
  55     <td><code>nonwikiword</code></td>
  56     <td> if defined, a non-wikiword is acceptable for the new topic name </td>
  57   </tr>
  58 </table>
  59
  60 ## <a name="StaticMethod &lt;strong&gt;move&lt;/strong&gt; ($session,$o"></a> [[StaticMethod]] **move** `($session,$oldWeb,$oldTopic,$newWeb,$newTopic,$attachment,\@refs)`
  61
  62 Move the given topic, or an attachment in the topic, correcting refs to the topic in the topic itself, and in the list of topics (specified as web.topic pairs) in the \\@refs array.
  63
  64 - `$session` - reference to session object
  65 - `$oldWeb` - name of old web - must be untained
  66 - `$oldTopic` - name of old topic - must be untained
  67 - `$newWeb` - name of new web - must be untained
  68 - `$newTopic` - name of new topic - must be untained
  69 - `$attachment` - name of the attachment to move (from oldtopic to newtopic) (undef to move the topic) - must be untaineted
  70 - `\@refs` - array of webg.topics that must have refs to this topic converted
  71
  72 Will throw TWiki::OopsException or TWiki::AccessControlException on an error.
  73
  74 ## <a name="StaticMethod &lt;strong&gt;get_ReferringTopic"></a> [[StaticMethod]] \*getReferringTopics `($session,$web,$topic,$allWebs) -> \%matches`
  75
  76 - `$session` - the session
  77 - `$web` - web to search for
  78 - `$topic` - topic to search for
  79 - `$allWebs` - 0 to search $web only. 1 to search all webs _except_ $web.
  80
  81 Returns a hash that maps the web.topic name to a summary of the lines that matched. Will _not_ return $web.$topic in the list