Crontab
[ class tree: Crontab ] [ index: Crontab ] [ all elements ]
Packages:
apnscp_esprit
Admin
Aliases
Auth
Backup
Bandwidth
Billing
Common
CRM
Crontab
Demo
DNS
Email
File
Logs
Majordomo
Miscellaneous
Monitor
One-Click
Oneclick
Site
SQL
Statistics
Urchin
User
Version
Web


Files:
crontab.php

Classes:
Crontab_Module

Class: Crontab_Module

Source Location: /crontab.php

Class Overview

Module_Skeleton
   |
   --Crontab_Module

Variables

Methods

Class Details

[line 7]


[ Top ]

Class Variables

$mysql =

[line 8]



Tags:

access:  public

Type:   mixed


[ Top ]

$pgsql =

[line 9]



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

method add_cronjob [line 106]

bool add_cronjob( $mMinute, $mHour, $mDayOfMonth, $mMonth, $mDayOfWeek, $mCommand, array $mTimes, string $mCmd)

bool add_cronjob (array, string)



Tags:

return:  true on success, exception of type FileError on failure
privilege:  PRIVILEGE_SITE
access:  public


Parameters:

array   $mTimes   an associative array of corresponding values for minute, hour, day of month, month, day of week
string   $mCmd   command name to execute
   $mMinute  
   $mHour  
   $mDayOfMonth  
   $mMonth  
   $mDayOfWeek  
   $mCommand  

[ Top ]

method add_cronjob_backend [line 118]

bool add_cronjob_backend( $mCmd $mCmd)

bool add_cronjob_backend (string)



Tags:

return:  true on successfully added
privilege:  SERVER_EXEC|PRIVILEGE_SITE
access:  public


Parameters:

$mCmd   $mCmd   full cronjob line to add to the user's cronjob listing

[ Top ]

method crontab_enabled [line 94]

bool crontab_enabled( )

bool crontab_enabled() Returns true if the cron daemon is running within the environment, false if not. Note well that it will return false IF the cron daemon is installed within the account, but is not running on the system.



Tags:

return:  true if crontab service enabled for domain
privilege:  PRIVILEGE_SITE
access:  public


[ Top ]

method delete_cronjob [line 151]

bool delete_cronjob( mixed $mMinute, mixed $mHour, mixed $mDayOfMonth, mixed $mMonth, mixed $mDayOfWeek, string $mCommand)

bool delete_cronjob (mixed mixed mixed mixed mixed mixed)



Tags:

return:  true on the command being successfully found and removed
privilege:  PRIVILEGE_SITE
access:  public


Parameters:

mixed   $mMinute  
mixed   $mHour  
mixed   $mDayOfMonth  
mixed   $mMonth  
mixed   $mDayOfWeek  
string   $mCommand  

[ Top ]

method delete_cronjob_backend [line 171]

bool delete_cronjob_backend( mixed $mMinute, mixed $mHour, mixed $mDayOfMonth, mixed $mMonth, mixed $mDayOfWeek, string $mCommand)

bool delete_cronjob_backend (mixed mixed mixed mixed mixed mixed)



Tags:

return:  true on the command being successfully found and removed delete_cronjob
privilege:  PRIVILEGE_SITE
access:  public


Parameters:

mixed   $mMinute  
mixed   $mHour  
mixed   $mDayOfMonth  
mixed   $mMonth  
mixed   $mDayOfWeek  
string   $mCommand  

[ Top ]

method list_cronjobs [line 48]

array list_cronjobs( )

array list_cronjobs()

Invokes crontab -l from the shell and returns the output as an associative array




Tags:

return:  indexes:
  • hour
  • minute
  • day_of_month
  • month
  • day_of_week
  • cmd
returns NULL if no cronjobs exist for specific user or PermissionError if pre-req SSH is not satisfied
privilege:  PRIVILEGE_SITE
access:  public


[ Top ]

method list_cronjobs_backend [line 65]

array list_cronjobs_backend( )

array list_cronjobs_backend



Tags:

return:  of associative elements add_cronjob NULL if no cronjobs exist for user
privilege:  PRIVILEGE_SITE|PRIVILEGE_SERVER_EXEC
access:  public


[ Top ]

method toggle_crontab_status [line 219]

true toggle_crontab_status( bool $mStatus)

bool toggle_crontab_status (integer)



Tags:

return:  if new state is turned on, false if new state is turned off, PermissionError if prereq SSH is not enabled for site
privilege:  PRIVILEGE_SITE
access:  public


Parameters:

bool   $mStatus   true to turn it on, false to turn it off

[ Top ]

Documentation generated on Sat, 05 Jul 2008 04:00:34 -0400 by phpDocumentor 1.4.0