Overview

Namespaces

  • Charcoal
    • App
      • Action
      • Config
      • Handler
      • Middleware
      • Module
      • Route
      • Script
      • ServiceProvider
      • Template

Classes

  • AbstractScript

Interfaces

  • CronScriptInterface
  • ScriptInterface

Traits

  • ArgScriptTrait
  • CronScriptTrait
  • PathScriptTrait
  • Overview
  • Namespace
  • Class

Trait CronScriptTrait

Cron-job utilities

Namespace: Charcoal\App\Script
Located at Charcoal/App/Script/CronScriptTrait.php
Methods summary
public Charcoal\App\Script\CronScriptInterface
# setUseLock( boolean $useLock )

Parameters

$useLock
The boolean flag if a lock should be used.

Returns

Charcoal\App\Script\CronScriptInterface
Chainable
public boolean
# useLock( )

Returns

boolean
public boolean
# startLock( )

Returns

boolean

Throws

Exception
If the lock file can not be opened.
public
# stopLock( )
API documentation generated by ApiGen