Wiki : PageLock
Documentation Home :: Categories :: Index :: Recent Changes :: Comments :: Search :: Help :: Login/Register
Most recent edit on 2007-03-16 21:23:49 by JørnWildt Removing Franky's rant
Additions:
4. User B saves his work and thereby overwrites user A's work without even knowing it.
Deletions:
4. User B saves his work and thereby overwrites user A's work.
Usually everything is fine, because in this example, A is a woman and B is a man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-03-07 18:00:56 by Landseer
Additions:
Usually everything is fine, because in this example, A is a woman and B is a man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Deletions:
Usually everything is fine, because in this example, A is a woman and B is man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-03-07 17:01:34 by Landseer minor change :-D
Additions:
Usually everything is fine, because in this example, A is a woman and B is man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-02-27 22:42:08 by JørnWildt
Additions:
2. User B edits the same article. But the page is overlaid with a dark transparent skin that blocks the interface. In the middle there's a message "This page is locked by another user" plus some more detailed information about the lock.
This is what the PageLock module will do for you. When user A opens her window it will register it and start pinging the server (using AJAX) every X sec. to ensure the lock is kept. When user B opens his window then it is blocked, but keep pinging the server (also using AJAX) until user A releases the lock.
To require a lock you add the code below right before your function finishes (typically right before or after fecthing HTML from the render object):
This will add some JavaScript? in the page header that will take care of the rest.
Deletions:
2. User B edits the same article. But the page is overlaid with a dark transparent skin that blocks the inerface. In the middle there's a message "This page is locked by another user".
This is what the PageLock module will do for you. When user A opens her window it will register it and start pinging the server (using AJAX) every 20 sec. to ensure the lock is kept. When user B opens his window then it is blocked, but keep pinging the server (also using AJAX) until user A releases the lock.
To require a lock you add this code right before your function finishes (typically right before or after fecthing HTML from the render object):
Oldest known version of this page was edited on 2007-02-27 22:36:00 by JørnWildt [ Backup ]
Single user page access using PageLock module
To release a lock you add this code right after handling user buttons (cancel or submit):
You can find the complete example in the HowToPnForms∞ module (pnrecipe.php).
Lock name scheme
Additions:
4. User B saves his work and thereby overwrites user A's work without even knowing it.
Deletions:
4. User B saves his work and thereby overwrites user A's work.
Usually everything is fine, because in this example, A is a woman and B is a man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-03-07 18:00:56 by Landseer
Additions:
Usually everything is fine, because in this example, A is a woman and B is a man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Deletions:
Usually everything is fine, because in this example, A is a woman and B is man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-03-07 17:01:34 by Landseer minor change :-D
Additions:
Usually everything is fine, because in this example, A is a woman and B is man. But sometimes we have to take care about what they say (there is a 50% chance that they are right).
Edited on 2007-02-27 22:42:08 by JørnWildt
Additions:
2. User B edits the same article. But the page is overlaid with a dark transparent skin that blocks the interface. In the middle there's a message "This page is locked by another user" plus some more detailed information about the lock.
This is what the PageLock module will do for you. When user A opens her window it will register it and start pinging the server (using AJAX) every X sec. to ensure the lock is kept. When user B opens his window then it is blocked, but keep pinging the server (also using AJAX) until user A releases the lock.
To require a lock you add the code below right before your function finishes (typically right before or after fecthing HTML from the render object):
This will add some JavaScript? in the page header that will take care of the rest.
Lock name scheme
If all of this is to work then we must use a consistent lock name scheme. I suggest to concatenate module name, table name, and edited item ID: "<Module><Table><ID>" - like for instance "HowtoPnFormsRecipe42?".Zikula .8 implementation
The PageLock module was added too late to make it in the .8 version, so you can only find examples in the HowToPnForms? module.Deletions:
2. User B edits the same article. But the page is overlaid with a dark transparent skin that blocks the inerface. In the middle there's a message "This page is locked by another user".
This is what the PageLock module will do for you. When user A opens her window it will register it and start pinging the server (using AJAX) every 20 sec. to ensure the lock is kept. When user B opens his window then it is blocked, but keep pinging the server (also using AJAX) until user A releases the lock.
To require a lock you add this code right before your function finishes (typically right before or after fecthing HTML from the render object):
Lock name scheme
Oldest known version of this page was edited on 2007-02-27 22:36:00 by JørnWildt [ Backup ]
Single user page access using PageLock module
The core PageLock module can be used to restrict access to a certain page in such a way that only one user at a time has access to it. This can be used to avoid a classic concurrency problem:
- User A starts editing an article.
- User B edits the same article.
- User A saves her work.
- User B saves his work and thereby overwrites user A's work.
If we add a page locking feature to the editing page then this would happen instead:
- User A starts editing an article.
- User B edits the same article. But the page is overlaid with a dark transparent skin that blocks the inerface. In the middle there's a message "This page is locked by another user".
- User B waits until A is finished editing.
- After some time user A commits her work and user B's window automatically reloads with the new data ready to edit.
This is what the PageLock module will do for you. When user A opens her window it will register it and start pinging the server (using AJAX) every 20 sec. to ensure the lock is kept. When user B opens his window then it is blocked, but keep pinging the server (also using AJAX) until user A releases the lock.
All you need to do is to call two API functions and pass in two variables:
- A lock name.
- A return URL for returning from a blocked window (when user B gives up and presses "cancel").
To require a lock you add this code right before your function finishes (typically right before or after fecthing HTML from the render object):
To release a lock you add this code right after handling user buttons (cancel or submit):
pnModAPIFunc('PageLock', 'user', 'releaseLock',
array('lockName' => "HowtoPnFormsRecipe{$this->recipeId}"));
array('lockName' => "HowtoPnFormsRecipe{$this->recipeId}"));
You can find the complete example in the HowToPnForms∞ module (pnrecipe.php).
Lock name scheme
|
Last Editor :
Owner :