SproutCMS

This is the code documentation for the SproutCMS project

function lock()

Locks the given record for the current user

Usage

int Admin::lock ( string $ctlr , int $record_id );

Arguments

  1. string $ctlr
    The controller responsible for the record
  2. int $record_id
    The record ID

Exceptions thrown

  • Exception
    If the lock fails to acquire

Return value

  • int
    Lock id