Alberto Manuel Brandão Simões > Quiki-0.12 > Quiki::Users

Download:
Quiki/Quiki-0.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Quiki::Users - Quiki pages manager

SYNOPSIS ^

  use Quiki::Pages;

  # lock a node
  Quiki::Pages->lock($node, $self->{sid});

  # unlock a node
  Quiki::Pages->unlock($node);

  # verify lock status
  $locked = Quiki::Pages->locked($node, $self->{sid}))

  # check in new content
  Quiki::Pages->check_in($self, $node, $content);

  # retrieve content
  $content = Quiki::Pages->check_out($self,$node,$rev);

DESCRIPTION ^

This module is handles the needed operations to maintain the pages information. It is used to gain and free locks to edit pages, and implements a simple revision system for page's content.

lock

This method is used to gain a lock to edit a given page.

unlock

This method is used to free a lock to edit a given page.

locked

This method is used to verify if exists a lock to a given page. It returns false (page not locked) if there isn't a lock or, if a user is supplied and that user owns the lock.

locked_for_user

This method is similar to locked and needs that a user is supplied. It returns true only if the page is locked by the supplied user.

check_in

This method is used to update new content to a page. It creates a diff file and increments the revision number.

check_out

This method returns the content for a given page and revision number.

calc_diff

This method calculates the diff between any two given revisions for a page.

SEE ALSO ^

Quiki, perl(1)

AUTHOR ^

Alberto Simões, <ambs@cpan.org> Nuno Carvalho, <smash@cpan.org>

COPYRIGHT & LICENSE ^

Copyright 2009-2010 Alberto Simoes and Nuno Carvalho.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: