jon48 / webtrees-lib

src/Webtrees/Constants.php

Indentation +10 added lines, -10 removed lines

@@ -14,17 +14,17 @@ 
  */
 class Constants {
     
-    const LIB_NAMESPACE = __NAMESPACE__;
+	const LIB_NAMESPACE = __NAMESPACE__;
 	
-    /** Internal name of the Certificates Module
-     * @var string
-     */
-    const MODULE_MAJ_CERTIF_NAME = 'myartjaub_certificates';
+	/** Internal name of the Certificates Module
+	 * @var string
+	 */
+	const MODULE_MAJ_CERTIF_NAME = 'myartjaub_certificates';
     
-    /** Internal name of the GeoDispersion Module
-     * @var string
-     */
-    const MODULE_MAJ_GEODISP_NAME = 'myartjaub_geodispersion';
+	/** Internal name of the GeoDispersion Module
+	 * @var string
+	 */
+	const MODULE_MAJ_GEODISP_NAME = 'myartjaub_geodispersion';
     
 	/** Internal name of the Hooks Module
 	 * @var string
@@ -61,7 +61,7 @@ 
 	 * @return string $WT_RAPHAEL_JS_URL
 	 */
 	public static function WT_RAPHAEL_JS_URL() {
-	    return WT_STATIC_URL . 'packages/raphael-2.1.4/raphael-min.js';
+		return WT_STATIC_URL . 'packages/raphael-2.1.4/raphael-min.js';
 	}
 		
 }
\ No newline at end of file

src/Webtrees/Module/ModuleMenuItemInterface.php

Indentation +7 added lines, -7 removed lines

@@ -15,11 +15,11 @@
  */
 interface ModuleMenuItemInterface
 {
-    /**
-     * Returns a menu item for the module.
-     * 
-     * @param \Fisharebest\Webtrees\Tree|null $tree
-     * @param mixed $reference
-     */
-    public function getMenu(\Fisharebest\Webtrees\Tree $tree, $reference);
+	/**
+	 * Returns a menu item for the module.
+	 * 
+	 * @param \Fisharebest\Webtrees\Tree|null $tree
+	 * @param mixed $reference
+	 */
+	public function getMenu(\Fisharebest\Webtrees\Tree $tree, $reference);
 }
\ No newline at end of file

src/Webtrees/Module/AdminTasks/TaskController.php

Indentation +65 added lines, -65 removed lines

@@ -35,25 +35,25 @@ 
  */
 class TaskController extends MvcController
 {    
-    /**
-     * Tasks Provider
-     * @var TaskProviderInterface $provider
-     */
-    protected $provider;    
+	/**
+	 * Tasks Provider
+	 * @var TaskProviderInterface $provider
+	 */
+	protected $provider;    
     
-    /**
-     * Constructor for Admin Config controller
-     * @param AbstractModule $module
-     */
-    public function __construct(AbstractModule $module) {
-        parent::__construct($module);
+	/**
+	 * Constructor for Admin Config controller
+	 * @param AbstractModule $module
+	 */
+	public function __construct(AbstractModule $module) {
+		parent::__construct($module);
         
-        $this->provider = $this->module->getProvider();
-    }    
+		$this->provider = $this->module->getProvider();
+	}    
     
-    /**
-     * Pages
-     */        
+	/**
+	 * Pages
+	 */        
 	
 	/**
 	 * Task@trigger
@@ -77,35 +77,35 @@ 
 	/**
 	 * Task@setStatus
 	 */
-    public function setStatus() {          
-        $controller = new JsonController();
+	public function setStatus() {          
+		$controller = new JsonController();
         
-        $task_name = Filter::get('task');
-        $task = $this->provider->getTask($task_name, false);
+		$task_name = Filter::get('task');
+		$task = $this->provider->getTask($task_name, false);
         
-        $controller->restrictAccess(
-            true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
-            &&  Auth::isAdmin() 
-            && $task
-        );
+		$controller->restrictAccess(
+			true // Filter::checkCsrf()   -- Cannot use CSRF on a GET request (modules can only work with GET requests)
+			&&  Auth::isAdmin() 
+			&& $task
+		);
         
-        $status = Filter::getBool('status');
-        $res = array('task' => $task->getName() , 'error' => null);
-        try{
-            $this->provider->setTaskStatus($task, $status);
-            $res['status'] = $status;
+		$status = Filter::getBool('status');
+		$res = array('task' => $task->getName() , 'error' => null);
+		try{
+			$this->provider->setTaskStatus($task, $status);
+			$res['status'] = $status;
 			Log::addConfigurationLog('Module '.$this->module->getName().' : Admin Task "'.$task->getName().'" has been '. ($status ? 'enabled' : 'disabled') .'.');
-        }
-        catch (\Exception $ex) {
-            $res['error'] = $ex->getMessage();
+		}
+		catch (\Exception $ex) {
+			$res['error'] = $ex->getMessage();
 			Log::addErrorLog('Module '.$this->module->getName().' : Admin Task "'.$task->getName().'" could not be ' . ($status ? 'enabled' : 'disabled') .'. Error: '. $ex->getMessage());
-        }
+		}
         
-        $controller->pageHeader();
-        if($res['error']) http_response_code(500);
+		$controller->pageHeader();
+		if($res['error']) http_response_code(500);
         
-        echo \Zend_Json::encode($res);
-    }
+		echo \Zend_Json::encode($res);
+	}
 	
 	/**
 	 * Task@edit
@@ -113,15 +113,15 @@ 
 	public function edit() {
 		global $WT_TREE;
         		
-        $task_name = Filter::get('task');
-        $task = $this->provider->getTask($task_name, false);
+		$task_name = Filter::get('task');
+		$task = $this->provider->getTask($task_name, false);
 		
-        Theme::theme(new AdministrationTheme)->init($WT_TREE);
-        $controller = new PageController();        
-        $controller
-            ->restrictAccess(Auth::isAdmin() && $task)
+		Theme::theme(new AdministrationTheme)->init($WT_TREE);
+		$controller = new PageController();        
+		$controller
+			->restrictAccess(Auth::isAdmin() && $task)
 			->setPageTitle(I18N::translate('Edit the administrative task'))
-            ->addInlineJavascript('
+			->addInlineJavascript('
                 function toggleRemainingOccurrences() {
                     if($("input:radio[name=\'is_limited\']:checked").val() == 1) {
                         $("#nb_occurences").show();
@@ -134,39 +134,39 @@ 
                 $("[name=\'is_limited\']").on("change", toggleRemainingOccurrences);
                 toggleRemainingOccurrences();
             ')
-        ;
+		;
         
         
-        $data = new ViewBag();        
-        $data->set('title', $controller->getPageTitle());
+		$data = new ViewBag();        
+		$data->set('title', $controller->getPageTitle());
 		$data->set('admin_config_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig&ged=' . $WT_TREE->getNameUrl());
-        $data->set('module_title', $this->module->getTitle());
+		$data->set('module_title', $this->module->getTitle());
 		$data->set('save_url', 'module.php?mod=' . $this->module->getName() . '&mod_action=Task@save&ged=' . $WT_TREE->getNameUrl());
 		$data->set('task', $task);
 		    
-        ViewFactory::make('TaskEdit', $this, $controller, $data)->render();	
+		ViewFactory::make('TaskEdit', $this, $controller, $data)->render();	
 	}	
 	
 	/**
 	 * Task@save
 	 */
 	public function save() {		
-        $tmp_contrl = new PageController();
+		$tmp_contrl = new PageController();
 				
-        $tmp_contrl->restrictAccess(
-            Auth::isAdmin() 
-            && Filter::checkCsrf()
-         );
+		$tmp_contrl->restrictAccess(
+			Auth::isAdmin() 
+			&& Filter::checkCsrf()
+		 );
         
 		$task_name      = Filter::post('task');
-        $frequency    	= Filter::postInteger('frequency');
-        $is_limited  	= Filter::postInteger('is_limited', 0, 1);
-        $nb_occur       = Filter::postInteger('nb_occur');
+		$frequency    	= Filter::postInteger('frequency');
+		$is_limited  	= Filter::postInteger('is_limited', 0, 1);
+		$nb_occur       = Filter::postInteger('nb_occur');
 				
 		$task = $this->provider->getTask($task_name, false);
         
-        $success = false; 
-        if($task) {
+		$success = false; 
+		if($task) {
 			$task->setFrequency($frequency);
 			if($is_limited == 1) {
 				$task->setRemainingOccurrences($nb_occur);
@@ -198,13 +198,13 @@ 
 				Log::addConfigurationLog('Module '.$this->module->getName().' : AdminTask “'. $task->getName() .'” could not be updated. See error log.');
 			}
 			
-        }
+		}
         
-        $redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig';
-        if(!$success) {
+		$redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=AdminConfig';
+		if(!$success) {
 			$redirection_url = 'module.php?mod=' . $this->module->getName() . '&mod_action=Task@edit&task='. $task->getName();
-        }        
-        header('Location: ' . WT_BASE_URL . $redirection_url);
+		}        
+		header('Location: ' . WT_BASE_URL . $redirection_url);
 	}
      
 }
\ No newline at end of file

src/Webtrees/Module/AdminTasks/Model/AbstractTask.php

Indentation +195 added lines, -195 removed lines

@@ -21,254 +21,254 @@
  */
 abstract class AbstractTask {
     
-    /**
-     * Time out for runnign tasks, in seconds. Default 5 min
-     * @var int TASK_TIME_OUT
-     */
-    const TASK_TIME_OUT = 300;
+	/**
+	 * Time out for runnign tasks, in seconds. Default 5 min
+	 * @var int TASK_TIME_OUT
+	 */
+	const TASK_TIME_OUT = 300;
               
-    /**
-     * Task provider
-     * @var TaskProviderInterface $provider
-     */
+	/**
+	 * Task provider
+	 * @var TaskProviderInterface $provider
+	 */
 	protected $provider;
 			
 	/**
 	 * Task name
 	 * @var string $name
 	 */
-    protected $name;
+	protected $name;
     
-    /**
-     * Status of the task
-     * @var bool $is_enabled
-     */
-    protected $is_enabled;
+	/**
+	 * Status of the task
+	 * @var bool $is_enabled
+	 */
+	protected $is_enabled;
     
-    /**
-     * Last updated date
-     * @var \DateTime $last_updated
-     */
-    protected $last_updated;
+	/**
+	 * Last updated date
+	 * @var \DateTime $last_updated
+	 */
+	protected $last_updated;
     
-    /**
-     * Last run result
-     * @var bool $last_result
-     */
-    protected $last_result;
+	/**
+	 * Last run result
+	 * @var bool $last_result
+	 */
+	protected $last_result;
     
-    /**
-     * Task run frequency
-     * @var int $frequency
-     */
-    protected $frequency;
+	/**
+	 * Task run frequency
+	 * @var int $frequency
+	 */
+	protected $frequency;
     
-    /**
-     * Task remaining runs
-     * @var int $nb_occurrences
-     */
-    protected $nb_occurrences;
+	/**
+	 * Task remaining runs
+	 * @var int $nb_occurrences
+	 */
+	protected $nb_occurrences;
     
-    /**
-     * Current running status of the task
-     * @var bool $is_running
-     */
-    protected $is_running;
+	/**
+	 * Current running status of the task
+	 * @var bool $is_running
+	 */
+	protected $is_running;
     
-    /**
-     * Constructor for the Admin task class
+	/**
+	 * Constructor for the Admin task class
 	 *
 	 * @param string $file Filename containing the task object
 	 * @param TaskProviderInterface $provider Provider for tasks
-     */
-    public function __construct($file, TaskProviderInterface $provider = null){
-        $this->name = trim(basename($file, '.php'));
+	 */
+	public function __construct($file, TaskProviderInterface $provider = null){
+		$this->name = trim(basename($file, '.php'));
 		$this->provider = $provider;
-    }
+	}
     
-    /**
-     * Get the provider.
-     *
-     * @return TaskProviderInterface 
-     */
-    public function getProvider(){
-        return $this->provider;
-    }
+	/**
+	 * Get the provider.
+	 *
+	 * @return TaskProviderInterface 
+	 */
+	public function getProvider(){
+		return $this->provider;
+	}
     
-    /**
-     * Set the provider.
-     *
-     * @param TaskProviderInterface $provider
-     * @return self Enable method-chaining
-     */
-    public function setProvider(TaskProviderInterface $provider){
-        $this->provider = $provider;
-        return $this;
-    }
+	/**
+	 * Set the provider.
+	 *
+	 * @param TaskProviderInterface $provider
+	 * @return self Enable method-chaining
+	 */
+	public function setProvider(TaskProviderInterface $provider){
+		$this->provider = $provider;
+		return $this;
+	}
     
-    /**
-     * Set parameters of the Task
-     *
-     * @param bool $is_enabled Status of the task
-     * @param \DateTime $lastupdated Time of the last task run
-     * @param bool $last_result Result of the last run, true for success, false for failure
-     * @param int $frequency Frequency of execution in minutes
-     * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited
-     * @param bool $is_running Indicates if the task is currently running
-     */
-    public function setParameters($is_enabled, \DateTime $last_updated, $last_result, $frequency, $nb_occur, $is_running){
-        $this->is_enabled = $is_enabled;
-        $this->last_updated = $last_updated;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occur;
-        $this->is_running = $is_running;
-    }
+	/**
+	 * Set parameters of the Task
+	 *
+	 * @param bool $is_enabled Status of the task
+	 * @param \DateTime $lastupdated Time of the last task run
+	 * @param bool $last_result Result of the last run, true for success, false for failure
+	 * @param int $frequency Frequency of execution in minutes
+	 * @param int $nb_occur Number of remaining occurrences, 0 for tasks not limited
+	 * @param bool $is_running Indicates if the task is currently running
+	 */
+	public function setParameters($is_enabled, \DateTime $last_updated, $last_result, $frequency, $nb_occur, $is_running){
+		$this->is_enabled = $is_enabled;
+		$this->last_updated = $last_updated;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occur;
+		$this->is_running = $is_running;
+	}
     
-    /**
-     * Get the name of the task
-     *
-     * @return string
-     */
-    public function getName(){
-        return $this->name;
-    }
+	/**
+	 * Get the name of the task
+	 *
+	 * @return string
+	 */
+	public function getName(){
+		return $this->name;
+	}
     
     
-    /**
-     * Return the status of the task in a boolean way
-     *
-     * @return boolean True if enabled
-     */
-    public function isEnabled(){
-        return $this->is_enabled;
-    }
+	/**
+	 * Return the status of the task in a boolean way
+	 *
+	 * @return boolean True if enabled
+	 */
+	public function isEnabled(){
+		return $this->is_enabled;
+	}
     
-    /**
-     * Get the last updated time.
-     *
-     * @return \DateTime
-     */
-    public function getLastUpdated(){
-        return $this->last_updated;
-    }
+	/**
+	 * Get the last updated time.
+	 *
+	 * @return \DateTime
+	 */
+	public function getLastUpdated(){
+		return $this->last_updated;
+	}
     
-    /**
-     * Check if the last result has been successful.
-     *
-     * @return bool
-     */
-    public function isLastRunSuccess(){
-        return $this->last_result;
-    }
+	/**
+	 * Check if the last result has been successful.
+	 *
+	 * @return bool
+	 */
+	public function isLastRunSuccess(){
+		return $this->last_result;
+	}
     
-    /**
-     * Get the task frequency.
-     *
-     * @return int
-     */
-    public function getFrequency(){
-        return $this->frequency;
-    }
+	/**
+	 * Get the task frequency.
+	 *
+	 * @return int
+	 */
+	public function getFrequency(){
+		return $this->frequency;
+	}
 	
 	/**
-     * Set the task frequency.
-     *
+	 * Set the task frequency.
+	 *
 	 * @param int $frequency
-     * @return self Enable method-chaining
-     */
-    public function setFrequency($frequency){
-        $this->frequency = $frequency;
+	 * @return self Enable method-chaining
+	 */
+	public function setFrequency($frequency){
+		$this->frequency = $frequency;
 		return $this;
-    }
+	}
     
-    /**
-     * Get the number of remaining occurrences.
-     *
-     * @return int
-     */
-    public function getRemainingOccurrences(){
-        return $this->nb_occurrences;
-    }
+	/**
+	 * Get the number of remaining occurrences.
+	 *
+	 * @return int
+	 */
+	public function getRemainingOccurrences(){
+		return $this->nb_occurrences;
+	}
 	
 	/**
-     * Set the number of remaining occurrences.
-     *
+	 * Set the number of remaining occurrences.
+	 *
 	 * @param int $nb_occur
-     * @return self Enable method-chaining
-     */
-    public function setRemainingOccurrences($nb_occur){
-        $this->nb_occurrences = $nb_occur;
+	 * @return self Enable method-chaining
+	 */
+	public function setRemainingOccurrences($nb_occur){
+		$this->nb_occurrences = $nb_occur;
 		return $this;
-    }
+	}
     
-    /**
-     * Check if the task if running.
-     *
-     * @return bool
-     */
-    public function isRunning(){
-        return $this->is_running;
-    }
+	/**
+	 * Check if the task if running.
+	 *
+	 * @return bool
+	 */
+	public function isRunning(){
+		return $this->is_running;
+	}
     
     
-    /**
-     * Return the name to display for the task
-     *
-     * @return string Title for the task
-     */
-    abstract public function getTitle();
+	/**
+	 * Return the name to display for the task
+	 *
+	 * @return string Title for the task
+	 */
+	abstract public function getTitle();
     
-    /**
-     * Return the default frequency for the execution of the task
-     *
-     * @return int Frequency for the execution of the task
-     */
-    abstract public function getDefaultFrequency();
+	/**
+	 * Return the default frequency for the execution of the task
+	 *
+	 * @return int Frequency for the execution of the task
+	 */
+	abstract public function getDefaultFrequency();
     
-    /**
-     * Execute the task's actions
-     */
-    abstract protected function executeSteps();
+	/**
+	 * Execute the task's actions
+	 */
+	abstract protected function executeSteps();
     
 	/**
 	 * Persist task state into database.
 	 * @return bool
 	 */
 	public function save() {
-	    if(!$this->provider) throw new \Exception('The task has not been initialised with a provider.');
+		if(!$this->provider) throw new \Exception('The task has not been initialised with a provider.');
 		return $this->provider->updateTask($this);
 	}
 	
-    /**
-     * Execute the task, default skeleton
-     *
-     */
-    public function execute(){
+	/**
+	 * Execute the task, default skeleton
+	 *
+	 */
+	public function execute(){
     
-        if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
-            $this->is_running = false;
+		if($this->last_updated->add(new \DateInterval('PT'.self::TASK_TIME_OUT.'S')) < new \DateTime())
+			$this->is_running = false;
     
-        if(!$this->is_running){  //TODO put in place a time_out for running...
-            //TODO Log the executions in the logs
-            $this->last_result = false;
-            $this->is_running = true;
-            $this->save();
+		if(!$this->is_running){  //TODO put in place a time_out for running...
+			//TODO Log the executions in the logs
+			$this->last_result = false;
+			$this->is_running = true;
+			$this->save();
     
-            Log::addDebugLog('Start execution of Admin task: '.$this->getTitle());
-            $this->last_result = $this->executeSteps();
-            if($this->last_result){
-                $this->last_updated = new \DateTime();
-                if($this->nb_occurrences > 0){
-                    $this->nb_occurrences--;
-                    if($this->nb_occurrences == 0) $this->is_enabled = false;
-                }
-            }
-            $this->is_running = false;
-            $this->save();
-            Log::addDebugLog('Execution completed for Admin task: '.$this->getTitle().' - '.($this->last_result ? 'Success' : 'Failure'));
-        }
-    }
+			Log::addDebugLog('Start execution of Admin task: '.$this->getTitle());
+			$this->last_result = $this->executeSteps();
+			if($this->last_result){
+				$this->last_updated = new \DateTime();
+				if($this->nb_occurrences > 0){
+					$this->nb_occurrences--;
+					if($this->nb_occurrences == 0) $this->is_enabled = false;
+				}
+			}
+			$this->is_running = false;
+			$this->save();
+			Log::addDebugLog('Execution completed for Admin task: '.$this->getTitle().' - '.($this->last_result ? 'Success' : 'Failure'));
+		}
+	}
     
     
 }

src/Webtrees/Module/AdminTasks/Model/ConfigurableTaskInterface.php

Indentation +5 added lines, -5 removed lines

@@ -15,11 +15,11 @@
  */
 interface ConfigurableTaskInterface {
     
-    /**
-     * Returns the HTML code to display the specific task configuration.
-     * 
-     * @return string HTML code
-     */
+	/**
+	 * Returns the HTML code to display the specific task configuration.
+	 * 
+	 * @return string HTML code
+	 */
 	function htmlConfigForm();
 	
 	/**

src/Webtrees/Module/AdminTasks/Model/TaskProviderInterface.php

Indentation +36 added lines, -36 removed lines

@@ -37,47 +37,47 @@
 	 */
 	public function setTaskStatus(AbstractTask $task, $status);
 		
-    /**
-     * Update an Admin Task in the database.
-     * 
-     * @param AbstractTask $task Task to update
-     * @return bool
-     */
-    function updateTask(AbstractTask $task);    
+	/**
+	 * Update an Admin Task in the database.
+	 * 
+	 * @param AbstractTask $task Task to update
+	 * @return bool
+	 */
+	function updateTask(AbstractTask $task);    
     
-    /**
-     * Delete the task from the database, in a transactional manner.
-     *
-     * @param string $task_name Task to delete
-     */
-    public function deleteTask($task_name);
+	/**
+	 * Delete the task from the database, in a transactional manner.
+	 *
+	 * @param string $task_name Task to delete
+	 */
+	public function deleteTask($task_name);
     
 
-    /**
-     * Returns the number of Admin Tasks (active and inactive).
-     *
-     * @return int
-     */
-    public function getTasksCount();
+	/**
+	 * Returns the number of Admin Tasks (active and inactive).
+	 *
+	 * @return int
+	 */
+	public function getTasksCount();
     
-    /**
-     * Return the list of Admin Tasks matching specified criterias.
-     *
-     * @param string $search Search criteria in analysis description
-     * @param array $order_by Columns to order by
-     * @param int $start Offset to start with (for pagination)
-     * @param int|null $limit Max number of items to return (for pagination)
-     * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis[]
-     */
-    function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null);
+	/**
+	 * Return the list of Admin Tasks matching specified criterias.
+	 *
+	 * @param string $search Search criteria in analysis description
+	 * @param array $order_by Columns to order by
+	 * @param int $start Offset to start with (for pagination)
+	 * @param int|null $limit Max number of items to return (for pagination)
+	 * @return \MyArtJaub\Webtrees\Module\GeoDispersion\Model\GeoAnalysis[]
+	 */
+	function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null);
     
-    /**
-     * Returns the list of tasks that are currently meant to run.
-     * Tasks to run can be forced, or can be limited to only one.
-     * 
-     * @param string|null $force Force the enabled tasks to run.
-     * @param string|null $task_name Name of the specific task to run
-     */
+	/**
+	 * Returns the list of tasks that are currently meant to run.
+	 * Tasks to run can be forced, or can be limited to only one.
+	 * 
+	 * @param string|null $force Force the enabled tasks to run.
+	 * @param string|null $task_name Name of the specific task to run
+	 */
 	function getTasksToRun($force = false, $task_name = null);
 		
 	/**

src/Webtrees/Module/AdminTasks/Model/TaskProvider.php

Indentation +147 added lines, -147 removed lines

@@ -20,32 +20,32 @@ 
  */
 class TaskProvider implements TaskProviderInterface {
     
-    /**
-     * Root path of thr folder containing the tasks
-     * @var string $root_path
-     */
-    protected $root_path;
+	/**
+	 * Root path of thr folder containing the tasks
+	 * @var string $root_path
+	 */
+	protected $root_path;
 	    
-    /**
-     * Constructor for the Task provider
-     * @param string $root_path
-     */
-    public function __construct($root_path) {
-        $this->root_path = $root_path;
+	/**
+	 * Constructor for the Task provider
+	 * @param string $root_path
+	 */
+	public function __construct($root_path) {
+		$this->root_path = $root_path;
 		$this->all_tasks = null;
-    }
+	}
 	
-    /**
-     * Load a task object from a file.
-     * 
-     * @param string $task_name Name of the task to load.
-     */
+	/**
+	 * Load a task object from a file.
+	 * 
+	 * @param string $task_name Name of the task to load.
+	 */
 	protected function loadTask($task_name) {
 		try {
 			if (file_exists($this->root_path . $task_name .'.php')) {
 				$task = include $this->root_path . $task_name .'.php';
 				if($task instanceof AbstractTask) {
-				    $task->setProvider($this);
+					$task->setProvider($this);
 					return $task;
 				}
 			}
@@ -55,22 +55,22 @@ 
 		return null;
 	}
 	
-    /**
-     * Creates and returns a Task object from a data row.
-     * The row data is expected to be an array with the indexes:
-     *  - majat_name: task name
-     *  - majat_status: task status
-     *  - majat_last_run: last run time
-     *  - majat_last_result: last run result
-     *  - majat_frequency: run frequency
-     *  - majat_nb_occur: remaining running occurrences
-     *  - majat_running: is task running
-     *
-     * @param array $row
-     * @return AbstractTask|null
-     */
-    protected function loadTaskFromRow($row) {
-        $task = $this->loadTask($row['majat_name']);
+	/**
+	 * Creates and returns a Task object from a data row.
+	 * The row data is expected to be an array with the indexes:
+	 *  - majat_name: task name
+	 *  - majat_status: task status
+	 *  - majat_last_run: last run time
+	 *  - majat_last_result: last run result
+	 *  - majat_frequency: run frequency
+	 *  - majat_nb_occur: remaining running occurrences
+	 *  - majat_running: is task running
+	 *
+	 * @param array $row
+	 * @return AbstractTask|null
+	 */
+	protected function loadTaskFromRow($row) {
+		$task = $this->loadTask($row['majat_name']);
         
 		if($task) {
 			$task->setParameters(
@@ -85,99 +85,99 @@ 
 			return $task;
 		}
 		else {
-		    $this->deleteTask($row['majat_name']);
+			$this->deleteTask($row['majat_name']);
 		}
 		return null;
-    }
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getTask()
-     */
-    public function getTask($task_name, $only_enabled = true) {
-        $args = array (
-            'task_name' => $task_name
-        );
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getTask()
+	 */
+	public function getTask($task_name, $only_enabled = true) {
+		$args = array (
+			'task_name' => $task_name
+		);
     
-        $sql = 'SELECT majat_name, majat_status, majat_last_run, majat_last_result, majat_frequency, majat_nb_occur, majat_running' .
-            ' FROM `##maj_admintasks`' .
-            ' WHERE majat_name = :task_name';
-        if($only_enabled) {
-            $sql .= ' AND majat_status = :status';
-            $args['status'] = 'enabled';
-        }
+		$sql = 'SELECT majat_name, majat_status, majat_last_run, majat_last_result, majat_frequency, majat_nb_occur, majat_running' .
+			' FROM `##maj_admintasks`' .
+			' WHERE majat_name = :task_name';
+		if($only_enabled) {
+			$sql .= ' AND majat_status = :status';
+			$args['status'] = 'enabled';
+		}
     
-        $task_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
+		$task_array = Database::prepare($sql)->execute($args)->fetchOneRow(\PDO::FETCH_ASSOC);
     
-        if($task_array) {
-            return $this->loadTaskFromRow($task_array);
-        }
+		if($task_array) {
+			return $this->loadTaskFromRow($task_array);
+		}
     
-        return null;
-    }
+		return null;
+	}
     
 	/**
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::setTaskStatus()
 	 */
-    public function setTaskStatus(AbstractTask $task, $status) {
-        Database::prepare(
-            'UPDATE `##maj_admintasks`'.
-            ' SET majat_status = :status'.
-            ' WHERE majat_name = :name'
-        )->execute(array(
-                'name' => $task->getName(),
+	public function setTaskStatus(AbstractTask $task, $status) {
+		Database::prepare(
+			'UPDATE `##maj_admintasks`'.
+			' SET majat_status = :status'.
+			' WHERE majat_name = :name'
+		)->execute(array(
+				'name' => $task->getName(),
 				'status' => $status ? 'enabled' : 'disabled'
-        ));
-    }
+		));
+	}
 	
    /**
     * {@inheritDoc}
     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::updateTask()
     */
-    public function updateTask(AbstractTask $task) {        
-        try{
-            Database::prepare(
-                'UPDATE `##maj_admintasks`'.
-                ' SET majat_status = :status,'.
-                ' majat_last_run = :last_run,'.
-                ' majat_last_result = :last_result,'.
-                ' majat_frequency = :frequency,'.
-                ' majat_nb_occur = :nb_occurrences,'.
-                ' majat_running = :is_running'.
-                ' WHERE majat_name = :name'
-                )->execute(array(
-                    'name' => $task->getName(),
-                    'status' => $task->isEnabled() ? 'enabled' : 'disabled',
-                    'last_run' => $task->getLastUpdated()->format('Y-m-d H:i:s'),
-                    'last_result' =>  $task->isLastRunSuccess() ? 1 : 0,
-                    'frequency' => $task->getFrequency(),
-                    'nb_occurrences' => $task->getRemainingOccurrences(),
-                    'is_running' => $task->isRunning() ? 1 : 0
-                ));
-            return true;
-        }
-        catch (\Exception $ex) {
-            Log::addErrorLog(sprintf('Error while updating the Admin Task %s. Exception: %s', $task->getName(), $ex->getMessage()));
-            return false;
-        }        
-    }
+	public function updateTask(AbstractTask $task) {        
+		try{
+			Database::prepare(
+				'UPDATE `##maj_admintasks`'.
+				' SET majat_status = :status,'.
+				' majat_last_run = :last_run,'.
+				' majat_last_result = :last_result,'.
+				' majat_frequency = :frequency,'.
+				' majat_nb_occur = :nb_occurrences,'.
+				' majat_running = :is_running'.
+				' WHERE majat_name = :name'
+				)->execute(array(
+					'name' => $task->getName(),
+					'status' => $task->isEnabled() ? 'enabled' : 'disabled',
+					'last_run' => $task->getLastUpdated()->format('Y-m-d H:i:s'),
+					'last_result' =>  $task->isLastRunSuccess() ? 1 : 0,
+					'frequency' => $task->getFrequency(),
+					'nb_occurrences' => $task->getRemainingOccurrences(),
+					'is_running' => $task->isRunning() ? 1 : 0
+				));
+			return true;
+		}
+		catch (\Exception $ex) {
+			Log::addErrorLog(sprintf('Error while updating the Admin Task %s. Exception: %s', $task->getName(), $ex->getMessage()));
+			return false;
+		}        
+	}
 	
 	/**
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getTasksCount()
 	 */
-    public function getTasksCount() {
-        return Database::prepare(
-            'SELECT COUNT(majat_name)' .
-            ' FROM `##maj_admintasks`'
-            )->execute()->fetchOne();
-    }
+	public function getTasksCount() {
+		return Database::prepare(
+			'SELECT COUNT(majat_name)' .
+			' FROM `##maj_admintasks`'
+			)->execute()->fetchOne();
+	}
 	
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getTasksToRun()
-     */
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getTasksToRun()
+	 */
 	public function getTasksToRun($force = false, $task_name = null) 
 	{
 		$res = array();
@@ -206,12 +206,12 @@ 
 		$data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
 		
 		foreach($data as $task_row) {
-            $task = $this->loadTaskFromRow($task_row);
+			$task = $this->loadTaskFromRow($task_row);
 			if($task)
 			{
 				$res[] = $task;
 			} 
-        }
+		}
 		
 		return $res;	
 	}
@@ -220,69 +220,69 @@ 
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getFilteredTasksList()
 	 */
-    public function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null){
-        $res = array();
+	public function getFilteredTasksList($search = null, $order_by = null, $start = 0, $limit = null){
+		$res = array();
             
-        $sql = 'SELECT majat_name, majat_status, majat_last_run, majat_last_result, majat_frequency, majat_nb_occur, majat_running' .
-            ' FROM `##maj_admintasks`';
+		$sql = 'SELECT majat_name, majat_status, majat_last_run, majat_last_result, majat_frequency, majat_nb_occur, majat_running' .
+			' FROM `##maj_admintasks`';
         
-        $args = array();
+		$args = array();
                 
-        if ($order_by) {
-            $sql .= ' ORDER BY ';
-            $i = 0;
-            foreach ($order_by as $key => $value) {
-                if ($i > 0) {
-                    $sql .= ',';
-                }
+		if ($order_by) {
+			$sql .= ' ORDER BY ';
+			$i = 0;
+			foreach ($order_by as $key => $value) {
+				if ($i > 0) {
+					$sql .= ',';
+				}
                 
-                switch ($value['dir']) {
-                    case 'asc':
-                        $sql .= $value['column'] . ' ASC ';
-                        break;
-                    case 'desc':
-                        $sql .= $value['column'] . ' DESC ';
-                        break;
-                }
-                $i++;
-            }
-        } else {
-            $sql .= ' ORDER BY majat_name ASC';
-        }
+				switch ($value['dir']) {
+					case 'asc':
+						$sql .= $value['column'] . ' ASC ';
+						break;
+					case 'desc':
+						$sql .= $value['column'] . ' DESC ';
+						break;
+				}
+				$i++;
+			}
+		} else {
+			$sql .= ' ORDER BY majat_name ASC';
+		}
         
-        if ($limit) {
-            $sql .= ' LIMIT :limit OFFSET :offset';
-            $args['limit']  = $limit;
-            $args['offset'] = $start;
-        }
+		if ($limit) {
+			$sql .= ' LIMIT :limit OFFSET :offset';
+			$args['limit']  = $limit;
+			$args['offset'] = $start;
+		}
             
-        $data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
+		$data = Database::prepare($sql)->execute($args)->fetchAll(\PDO::FETCH_ASSOC);
 
-        foreach($data as $ga) {
-            $task = $this->loadTaskFromRow($ga);
+		foreach($data as $ga) {
+			$task = $this->loadTaskFromRow($ga);
 			if($task && (empty($search) || ($search && strpos($task->getTitle(), $search) !== false)))
 			{
 				$res[] = $task;
 			}
-        }
+		}
 		
-        return $res;
-    }
+		return $res;
+	}
 	
 	
-    /**
-     * {inhericDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getInstalledTasks()
-     */
+	/**
+	 * {inhericDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskProviderInterface::getInstalledTasks()
+	 */
 	public function getInstalledTasks() {
 		$tasks=array();
 		$dir=opendir($this->root_path);
 		while (($file=readdir($dir))!==false){ 
 			try {
-			    if($file == '.' || $file == '..') continue;
+				if($file == '.' || $file == '..') continue;
 				$task = include $this->root_path . $file;
 				if($task ) {
-				    $task->setProvider($this);
+					$task->setProvider($this);
 					Database::prepare(
 						'INSERT IGNORE INTO `##maj_admintasks`'.
 						' (majat_name, majat_status, majat_frequency)'.

src/Webtrees/Module/AdminTasks/Tasks/HealthCheckEmailTask.php

Indentation +21 added lines, -21 removed lines

@@ -29,11 +29,11 @@ 
  */
 class HealthCheckEmailTask extends AbstractTask implements ConfigurableTaskInterface {
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\AbstractTask::getTitle()
-     */
-    public function getTitle() {
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\AbstractTask::getTitle()
+	 */
+	public function getTitle() {
 		return I18N::translate('Healthcheck Email');
 	}
 	
@@ -41,7 +41,7 @@ 
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\AbstractTask::getDefaultFrequency()
 	 */
-    public function getDefaultFrequency() {
+	public function getDefaultFrequency() {
 		return 10080;  // = 1 week = 7 * 24 * 60 min
 	}
     
@@ -49,7 +49,7 @@ 
 	 * {@inheritDoc}
 	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\AbstractTask::executeSteps()
 	 */
-    protected function executeSteps() {
+	protected function executeSteps() {
 	
 		$res = false;		
 		
@@ -63,14 +63,14 @@ 
 		$interval = max($this->frequency, $interval_sincelast);
 		$nbdays = ceil($interval / (24 * 60));
 				
-        // Check for updates
-        $latest_version_txt = Functions::fetchLatestVersion();
-        if (preg_match('/^[0-9.]+\|[0-9.]+\|/', $latest_version_txt)) {
-        	list($latest_version, $earliest_version, $download_url) = explode('|', $latest_version_txt);
-        } else {
-        	// Cannot determine the latest version
-        	list($latest_version, $earliest_version, $download_url) = explode('|', '||');
-        }
+		// Check for updates
+		$latest_version_txt = Functions::fetchLatestVersion();
+		if (preg_match('/^[0-9.]+\|[0-9.]+\|/', $latest_version_txt)) {
+			list($latest_version, $earliest_version, $download_url) = explode('|', $latest_version_txt);
+		} else {
+			// Cannot determine the latest version
+			list($latest_version, $earliest_version, $download_url) = explode('|', '||');
+		}
 		
 		// Users statistics
 		$warnusers = 0;
@@ -213,15 +213,15 @@ 
 		$html = '
 			<div class="form-group">
     			<label class="control-label col-sm-3"> '.
-    				I18N::translate('Enable healthcheck emails for') .
-    			'</label>
+					I18N::translate('Enable healthcheck emails for') .
+				'</label>
     			<div class="col-sm-9">';
 
 		foreach(Tree::getAll() as $tree){
 			if(Auth::isManager($tree)){	
-			    $html .= '<div class="form-group row">
+				$html .= '<div class="form-group row">
 			        <span class="col-sm-3 control-label">' .
-			             $tree->getTitle() .
+						 $tree->getTitle() .
 					'</span>
 					 <div class="col-sm-2">';
 				$html .= FunctionsEdit::editFieldYesNo('HEALTHCHECK_ENABLED_' . $tree->getTreeId(), $tree->getPreference('MAJ_AT_'.$this->getName().'_ENABLED', 1), 'class="radio-inline"');
@@ -230,8 +230,8 @@ 
 		}
 		
 		$html .= '	<p class="small text-muted">'.
-    					I18N::translate('Enable the health check emails for each of the selected trees.') .
-    				'</p>
+						I18N::translate('Enable the health check emails for each of the selected trees.') .
+					'</p>
     			</div>
     		</div>';
 			

src/Webtrees/Module/AdminTasks/Schema/Migration0.php

Indentation +10 added lines, -10 removed lines

@@ -24,16 +24,16 @@
 	 */
 	public function upgrade() {
 		Database::exec(
-		    'CREATE TABLE IF NOT EXISTS `##maj_admintasks` ('.
-		    ' majat_name 		    VARCHAR(32)                      NOT NULL,'.
-		    ' majat_status          ENUM(\'enabled\',\'disabled\') 	 NOT NULL DEFAULT \'disabled\','.
-		    ' majat_last_run 		DATETIME 					     NOT NULL DEFAULT \'2000-01-01 00:00:00\','.
-		    ' majat_last_result 	TINYINT(1)					     NOT NULL DEFAULT 1,'.		// 0 for error, 1 for success
-		    ' majat_frequency		INTEGER						     NOT NULL DEFAULT 10080,'.	// In min, Default every week
-		    ' majat_nb_occur	 	SMALLINT					     NOT NULL DEFAULT 0,'.
-		    ' majat_running 		TINYINT(1)					     NOT NULL DEFAULT 0,'.
-		    ' PRIMARY KEY (majat_name)'.
-		    ') COLLATE utf8_unicode_ci ENGINE=InnoDB'
+			'CREATE TABLE IF NOT EXISTS `##maj_admintasks` ('.
+			' majat_name 		    VARCHAR(32)                      NOT NULL,'.
+			' majat_status          ENUM(\'enabled\',\'disabled\') 	 NOT NULL DEFAULT \'disabled\','.
+			' majat_last_run 		DATETIME 					     NOT NULL DEFAULT \'2000-01-01 00:00:00\','.
+			' majat_last_result 	TINYINT(1)					     NOT NULL DEFAULT 1,'.		// 0 for error, 1 for success
+			' majat_frequency		INTEGER						     NOT NULL DEFAULT 10080,'.	// In min, Default every week
+			' majat_nb_occur	 	SMALLINT					     NOT NULL DEFAULT 0,'.
+			' majat_running 		TINYINT(1)					     NOT NULL DEFAULT 0,'.
+			' PRIMARY KEY (majat_name)'.
+			') COLLATE utf8_unicode_ci ENGINE=InnoDB'
 		);
 	}
 }