From: Tim Otten <totten@civicrm.org>
Date: Sat, 11 Apr 2015 03:40:10 +0000 (-0700)
Subject: JobLog.get API
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=0d57e900ff4e596902d00df9efec93ba35b67455;p=civicrm-core.git

JobLog.get API
---

diff --git a/api/v3/JobLog.php b/api/v3/JobLog.php
new file mode 100644
index 0000000000..8e6b58d2a6
--- /dev/null
+++ b/api/v3/JobLog.php
@@ -0,0 +1,38 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Retrieve one or more job log record.
+ *
+ * @param array $params
+ *   input parameters
+ *
+ * @return array
+ */
+function civicrm_api3_job_log_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php
index 2abc057c71..7f2108499d 100644
--- a/tests/phpunit/api/v3/SyntaxConformanceTest.php
+++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php
@@ -96,6 +96,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
     $this->toBeImplemented['create'] = array(
       'Cxn',
       'CxnApp',
+      'JobLog',
       'SurveyRespondant',
       'OptionGroup',
       'MailingRecipients',
@@ -110,6 +111,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
     $this->toBeImplemented['delete'] = array(
       'Cxn',
       'CxnApp',
+      'JobLog',
       'MembershipPayment',
       'OptionGroup',
       'SurveyRespondant',
diff --git a/xml/schema/Core/JobLog.xml b/xml/schema/Core/JobLog.xml
index b4383fa5d2..b47a752bbf 100644
--- a/xml/schema/Core/JobLog.xml
+++ b/xml/schema/Core/JobLog.xml
@@ -11,6 +11,7 @@
     <name>id</name>
     <type>int unsigned</type>
     <required>true</required>
+    <title>Job Log ID</title>
     <comment>Job log entry Id</comment>
     <add>4.1</add>
   </field>
@@ -20,6 +21,7 @@
   </primaryKey>
   <field>
     <name>domain_id</name>
+    <title>Domain ID</title>
     <type>int unsigned</type>
     <required>true</required>
     <pseudoconstant>
@@ -39,17 +41,20 @@
   <field>
     <name>run_time</name>
     <type>timestamp</type>
+    <title>Timestamp</title>
     <comment>Log entry date</comment>
     <add>4.1</add>
   </field>
   <field>
     <name>job_id</name>
+    <title>Job ID</title>
     <type>int unsigned</type>
     <comment>Pointer to job id - not a FK though, just for logging purposes</comment>
     <add>4.1</add>
   </field>
   <field>
     <name>name</name>
+    <title>Job Name</title>
     <type>varchar</type>
     <length>255</length>
     <comment>Title of the job</comment>
@@ -57,6 +62,7 @@
   </field>
   <field>
     <name>command</name>
+    <title>Command</title>
     <type>varchar</type>
     <length>255</length>
     <comment>Full path to file containing job script</comment>
@@ -64,6 +70,7 @@
   </field>
   <field>
     <name>description</name>
+    <title>Description</title>
     <type>varchar</type>
     <length>255</length>
     <comment>Title line of log entry</comment>
@@ -71,6 +78,7 @@
   </field>
   <field>
     <name>data</name>
+    <title>Extended Data</title>
     <type>text</type>
     <comment>Potential extended data for specific job run (e.g. tracebacks).</comment>
     <add>4.1</add>