AJAX_Locking
[ class tree: AJAX_Locking ] [ index: AJAX_Locking ] [ all elements ]
Packages:
AJAX_Locking


Files:
AJAX_Locking.php
Driver.php
File.php
MDB2.php
server.php
SharedMemory.php
test.php

Classes:
AJAX_Locking
AJAX_Locking_Driver
AJAX_Locking_Driver_File
AJAX_Locking_Driver_MDB2
AJAX_Locking_Driver_SharedMemory

Class: AJAX_Locking_Driver_SharedMemory

Source Location: /Driver/SharedMemory.php

Class Overview

AJAX_Locking_Driver
   |
   --AJAX_Locking_Driver_SharedMemory

A driver that use System_SharedMemory as data store

Variables

Methods

Inherited Variables

Class: AJAX_Locking_Driver

AJAX_Locking_Driver::$timeout

Inherited Methods

Class: AJAX_Locking_Driver

AJAX_Locking_Driver::AJAX_Locking_Driver()
Constructor
AJAX_Locking_Driver::delete()
Administrately delete lock
AJAX_Locking_Driver::getLocks()
Returns the list of all active locks for administration purpose
AJAX_Locking_Driver::lock()
Locks an object
AJAX_Locking_Driver::status()
Returns the status of the object (lock or unlocked)
AJAX_Locking_Driver::unlock()
Unlocks an object

Class Details

[line 8]
A driver that use System_SharedMemory as data store



[ Top ]

Class Variables

$shared =

[line 10]


Type:   mixed


[ Top ]


Class Methods

constructor AJAX_Locking_Driver_SharedMemory [line 17]

AJAX_Locking_Driver AJAX_Locking_Driver_SharedMemory( [mixed $type = false], [mixed $options = false], [mixed $timeout = false])

Constructor



[ Top ]

method lock [line 32]

boolean lock( mixed $user, string $type, mixed $id)

Locks an object



Tags:

return:  true if the unlock was successfull, false otherwise


Overrides AJAX_Locking_Driver::lock() (Locks an object)

Parameters:

mixed   $user   id of the user who wants to lock
string   $type   type/classname of the object
mixed   $id   id of the object

[ Top ]

method status [line 94]

string status( mixed $user, string $type, mixed $id)

Returns the status of the object (lock or unlocked)



Tags:

return:  the status and the owner of the object


Overrides AJAX_Locking_Driver::status() (Returns the status of the object (lock or unlocked))

Parameters:

mixed   $user   id of the user who wants to know the object's status
string   $type   type/classname of the object
mixed   $id   id of the object

[ Top ]

method unlock [line 65]

boolean unlock( mixed $user, string $type, mixed $id)

Unlocks an object



Tags:

return:  true if the unlock was successfull, false otherwise


Overrides AJAX_Locking_Driver::unlock() (Unlocks an object)

Parameters:

mixed   $user   id of the user who wants to unlock
string   $type   type/classname of the object
mixed   $id   id of the object

[ Top ]

Documentation generated on Tue, 13 Feb 2007 21:42:45 +0100 by phpDocumentor 1.3.0RC3