X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FJobManager.php;h=d41b66cf57465b8ad7e419ff04ebde1ad07a413a;hb=20f57460897100cb2aea105c40c16ab16604033a;hp=df490715a118bd3bbbdc5488df03f584295f188c;hpb=912a3736c0c169f3d27d9de8495a28983ba9bf4c;p=civicrm-core.git diff --git a/CRM/Core/JobManager.php b/CRM/Core/JobManager.php index df490715a1..d41b66cf57 100644 --- a/CRM/Core/JobManager.php +++ b/CRM/Core/JobManager.php @@ -1,9 +1,9 @@ fatalErrorHandler = 'CRM_Core_JobManager_scheduledJobFatalErrorHandler'; @@ -71,6 +74,9 @@ class CRM_Core_JobManager { * @access private * */ + /** + * @param bool $auth + */ public function execute($auth = TRUE) { $this->logEntry('Starting scheduled jobs execution'); @@ -101,11 +107,18 @@ class CRM_Core_JobManager { */ public function __destruct() {} + /** + * @param $entity + * @param $action + */ public function executeJobByAction($entity, $action) { $job = $this->_getJob(NULL, $entity, $action); $this->executeJob($job); } + /** + * @param $id + */ public function executeJobById($id) { $job = $this->_getJob($id); $this->executeJob($job); @@ -147,10 +160,14 @@ class CRM_Core_JobManager { * @access private * */ + /** + * @return array + */ private function _getJobs() { $jobs = array(); $dao = new CRM_Core_DAO_Job(); $dao->orderBy('name'); + $dao->domain_id = CRM_Core_Config::domainID(); $dao->find(); while ($dao->fetch()) { $temp = array(); @@ -168,6 +185,14 @@ class CRM_Core_JobManager { * @access private * */ + /** + * @param null $id + * @param null $entity + * @param null $action + * + * @return CRM_Core_ScheduledJob + * @throws Exception + */ private function _getJob($id = NULL, $entity = NULL, $action = NULL) { if (is_null($id) && is_null($action)) { CRM_Core_Error::fatal('You need to provide either id or name to use this method'); @@ -184,6 +209,12 @@ class CRM_Core_JobManager { return $job; } + /** + * @param $entity + * @param $job + * @param $params + * @param null $source + */ public function setSingleRunParams($entity, $job, $params, $source = NULL) { $this->_source = $source; $key = strtolower($entity . '_' . $job); @@ -197,6 +228,9 @@ class CRM_Core_JobManager { * @access public * */ + /** + * @param $message + */ public function logEntry($message) { $domainID = CRM_Core_Config::domainID(); $dao = new CRM_Core_DAO_JobLog(); @@ -230,6 +264,11 @@ class CRM_Core_JobManager { $dao->save(); } + /** + * @param $apiResult + * + * @return string + */ private function _apiResultToMessage($apiResult) { $status = $apiResult['is_error'] ? ts('Failure') : ts('Success'); $msg = CRM_Utils_Array::value('error_message', $apiResult, 'empty error_message!'); @@ -245,6 +284,11 @@ class CRM_Core_JobManager { } } +/** + * @param $message + * + * @throws Exception + */ function CRM_Core_JobManager_scheduledJobFatalErrorHandler($message) { throw new Exception("{$message['message']}: {$message['code']}"); }