[NFC] comment fixes relating to doc blocks, spelling

[civicrm-core.git] / CRM / Core / BAO / Job.php

diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php
index fcb749a2c791536af995ca76848ee0bd7a54dc6f..dfd28028a0e52b3d531853a4d0768f3ccc67ce5a 100644 (file)
--- a/CRM/Core/BAO/Job.php
+++ b/CRM/Core/BAO/Job.php
@@ -90,9 +90,8 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
    * @param bool $is_active
    *   Value we want to set the is_active field.
    *
-   * @return Object
-   *   DAO object on success, null otherwise
-   *
+   * @return bool
+   *   true if we found and updated the object, else false
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Job', $id, 'is_active', $is_active);
@@ -146,4 +145,25 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
     CRM_Core_DAO::executeQuery($query);
   }
 
+  /**
+   * Make a copy of a Job.
+   *
+   * @param int $id The job id to copy.
+   *
+   * @return CRM_Core_DAO
+   */
+  public static function copy($id, $params = array()) {
+    $fieldsFix = array(
+      'suffix' => array(
+        'name' => ' - ' . ts('Copy'),
+      ),
+      'replace' => $params,
+    );
+    $copy = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_Job', array('id' => $id), NULL, $fieldsFix);
+    $copy->save();
+    CRM_Utils_Hook::copy('Job', $copy);
+
+    return $copy;
+  }
+
 }