fix: add PHPDoc blocks to execute helpers, tighten test assertion

Add PHPDoc to syslog_execute_ticket_command() and
syslog_execute_alert_command() to match the documentation convention
used by surrounding helpers.

Narrow the test assertion from a broad substring that matched the
function definition to the full call signature with trailing semicolon,
so the check correctly detects missing call sites.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>

Author: somethingwithproof

functions.php

@@ -1081,6 +1081,15 @@ function syslog_array2xml($array, $tag = 'template') {
 	return $xml;
 }
 
+/**
+ * syslog_execute_ticket_command - run the configured ticketing command for an alert
+ *
+ * @param  array  $alert          The alert row from syslog_alert table
+ * @param  array  $hostlist       Hostnames matched by the alert
+ * @param  string $error_message  sprintf template used if exec() returns non-zero
+ *
+ * @return void
+ */
 function syslog_execute_ticket_command($alert, $hostlist, $error_message) {
 	$command = read_config_option('syslog_ticket_command');
 
@@ -1108,6 +1117,15 @@ function syslog_execute_ticket_command($alert, $hostlist, $error_message) {
 	}
 }
 
+/**
+ * syslog_execute_alert_command - run the per-alert shell command for a matched result
+ *
+ * @param  array  $alert     The alert row from syslog_alert table
+ * @param  array  $results   The matched syslog result row
+ * @param  string $hostname  Resolved hostname for the source device
+ *
+ * @return void
+ */
 function syslog_execute_alert_command($alert, $results, $hostname) {
 	$command = alert_replace_variables($alert, $results, $hostname);
 

tests/regression/issue278_command_execution_refactor_test.php

@@ -17,7 +17,7 @@
 	exit(1);
 }
 
-if (substr_count($functions, 'syslog_execute_ticket_command($alert, $hostlist') < 2) {
+if (substr_count($functions, 'syslog_execute_ticket_command($alert, $hostlist, $error_message);') < 2) {
 	fwrite(STDERR, "syslog_process_alerts() is not consistently using the ticket command helper.\n");
 	exit(1);
 }