Update with pfre changes

src/Controller/lib.php

@@ -420,10 +420,10 @@ function IsDgSubCat($str)
  * @param array $commands Available commands for the current model
  * @param array $argv Argument vector
  * @param string $cmd Method name, key to $commands
- * @param int $actual Given arg count
- * @param int $expected Expected arg count
- * @param int $acceptable Acceptable arg count
- * @param int $check Arg count used while validating
+ * @param int $actual Given arg count [out]
+ * @param int $expected Expected arg count [out]
+ * @param int $acceptable Acceptable arg count [out]
+ * @param int $check Arg count used while validating [out]
  */
 function ComputeArgCounts($commands, $argv, $cmd, &$actual, &$expected, &$acceptable, &$check)
 {
@@ -527,8 +527,6 @@ function ValidateArgs($commands, $command, $argv, $check)
  */
 function ExpandArgs(&$ArgV, &$Locale, &$View, &$Command)
 {
-	global $ModelFiles;
-
 	$valid= FALSE;
 
 	// Arg 0 contains all of the args as a json encoded string

src/Model/lib/Anchor.php

@@ -132,6 +132,8 @@ function split()
 	 * Generates anchor rule.
 	 * 
 	 * Inline rules are always appended to the end.
+	 * 
+	 * @return string String rule.
 	 */
 	function generate()
 	{
@@ -176,6 +178,7 @@ function genInline()
  * 
  * @param string $str List of rule definitions in an array.
  * @param bool $force If set, continues checking and validating even if there are errors or $MaxAnchorNesting is reached.
+ * @return bool TRUE if $str has inline anchor.
  */
 function IsInlineAnchor($str, $force= FALSE)
 {

src/Model/lib/Filter.php

@@ -250,6 +250,14 @@ function parseSourceHash()
 		}
 	}
 
+	/**
+	 * Generates rule.
+	 * 
+	 * The output of this function is returned to the View on the command line,
+	 * so we return the generated rule string.
+	 * 
+	 * @return string String rule.
+	 */
 	function generate()
 	{
 		$this->genAction();

src/Model/lib/Rule.php

@@ -257,9 +257,9 @@ function validate($ruleArray, $force= FALSE)
 	 * If a key in typedef is marked as 'require', it should exist in the rule array, otherwise is an error.
 	 * 
 	 * @param array $arr Rule array.
-	 * @param array $key Key to search in both rule array and typedef.
+	 * @param string $key Key to search in both rule array and typedef.
 	 * @param array $def Validation definition.
-	 * @param array $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
+	 * @param string $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
 	 * @param bool $force Parameter to pass to validation function.
 	 * @return bool TRUE if validated, FALSE if not.
 	 */
@@ -300,9 +300,9 @@ function validateKeyDef(&$arr, $key, $def, $parent, $force= FALSE)
 	 * the rule element does not have 'multi' or 'values'.
 	 * 
 	 * @param array $arr Rule array.
-	 * @param array $key Key to search in both rule array and typedef.
+	 * @param string $key Key to search in both rule array and typedef.
 	 * @param array $def Validation definition.
-	 * @param array $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
+	 * @param string $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
 	 * @param bool $force Parameter to pass to validation function.
 	 * @return bool TRUE if validated, FALSE if not.
 	 */
@@ -350,10 +350,10 @@ function validateArrayValues(&$arr, $key, $def, $parent, $force= FALSE)
 	 * 
 	 * Validation method should be defined as a regex or a function. Otherwise is an error.
 	 * 
-	 * @param array $arr Rule array.
-	 * @param array $key Key to search in both rule array and typedef.
+	 * @param string $key Key to search in both rule array and typedef.
+	 * @param mixed $value Value to validate, array or string.
 	 * @param array $def Validation definition.
-	 * @param array $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
+	 * @param string $parent If the value is an array within another array, this param represents the key of the parent array. Used in error reporting.
 	 * @param bool $force Parameter to pass to validation function.
 	 * @return bool TRUE if validated, FALSE if not.
 	 */
@@ -799,7 +799,7 @@ function genKey($key)
 	 * Caller may supply a leading and/or a trailing string to print.
 	 * 
  	 * @param string $key Key to print the value of.
- 	 * @param string $head Optional leading string.
+ 	 * @param string $head Optional leading string, may be NULL.
  	 * @param string $tail Optional trailing string.
 	 */
 	function genValue($key, $head= '', $tail= '')
@@ -829,7 +829,7 @@ function genItems($key, $head= '', $delimPre= '{', $delimPost= '}')
 	/**
 	 * Prints the given values in delimiters.
 	 * 
- 	 * @param array $items Values to print.
+ 	 * @param mixed $items Values to print, array or string.
  	 * @param string $head Optional leading string.
 	 * @param string $delimPre Opening delimiter.
 	 * @param string $delimPost Closing delimiter.

src/Model/lib/RuleSet.php

@@ -64,6 +64,7 @@ class RuleSet
 	 *
 	 * @param array $rulesArray List of rule definitions in an array.
 	 * @param bool $force Used to override validation or other types of errors, hence forces loading of rules.
+	 * @return bool Load result.
 	 */
 	function load($rulesArray, $force= FALSE)
 	{
@@ -117,6 +118,7 @@ function deleteRules()
 	 *
 	 * @param string $text Rule set in string format to parse.
 	 * @param bool $force Used to override validation or other types of errors, hence forces loading of rules.
+	 * @return bool Validation result.
 	 */
 	function parse($text, $force= FALSE)
 	{
@@ -263,6 +265,7 @@ function parse($text, $force= FALSE)
 	 * method validates the rules in the ruleset.
 	 *
 	 * @param bool $force Used to override validation or other types of errors, hence forces loading of rules.
+	 * @return bool Validation result.
 	 */
 	function validate($force= FALSE)
 	{
@@ -356,6 +359,7 @@ function parseInlineRules($ruleLines, &$str, &$index, $force= FALSE)
 	 * The default on the Display page is to print line numbers in front of each line. 
 	 *
 	 * @param bool $printNumbers Print line numbers.
+	 * @return string Generated rules.
 	 */
 	function generate($printNumbers= FALSE)
 	{

src/Model/model.php

@@ -620,7 +620,7 @@ function SetLogLevel($level)
 	/**
 	 * Enables or disables help boxes.
 	 * 
-	 * @param bool $bool TRUE to enable, FALSE otherwise.
+	 * @param string $bool 'TRUE' to enable, 'FALSE' otherwise.
 	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function SetHelpBox($bool)
@@ -668,7 +668,7 @@ function SetDefaultLocale($locale)
 	/**
 	 * Enables or disables HTTPs.
 	 * 
-	 * @param bool $bool TRUE to enable, FALSE to disable HTTPs.
+	 * @param string $bool 'TRUE' to enable, 'FALSE' otherwise.
 	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function SetForceHTTPs($bool)
@@ -682,7 +682,7 @@ function SetForceHTTPs($bool)
 	/**
 	 * Enables or disables SSH.
 	 * 
-	 * @param bool $bool TRUE to enable, FALSE otherwise.
+	 * @param string $bool 'TRUE' to enable, 'FALSE' otherwise.
 	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function SetUseSSH($bool)
@@ -861,7 +861,7 @@ function PutFile($file, $contents)
 	 *
 	 * @param string $file Config file.
 	 * @param string $name Name of NVP.
-	 * @param mixed $newvalue New value to set.
+	 * @param string $newvalue New value to set.
 	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function SetNVP($file, $name, $newvalue)
@@ -899,7 +899,7 @@ function SetNVP($file, $name, $newvalue)
 	 * @param string $name Name of NVP.
 	 * @param int $set There may be multiple parentheses in $re, which one to return.
 	 * @param string $trimchars Chars to trim in the results.
-	 * @return mixed Value of NVP or NULL on failure.
+	 * @return mixed Value of NVP or FALSE on failure.
 	 */
 	function GetNVP($file, $name, $set= 0, $trimchars= '')
 	{

src/Model/pf.php

@@ -610,7 +610,7 @@ function GetPfRules($file, $tmp= FALSE, $force= FALSE)
 	 * 
 	 * @todo Should we return success or fail status, instead of TRUE?
 	 *
-	 * @return string List of rule files.
+	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function GetPfRuleFiles()
 	{
@@ -740,7 +740,7 @@ function InstallPfRules($json, $file= NULL, $load= TRUE, $force= FALSE)
 	 * 
 	 * Strips the file path, because we work with files under $PF_CONFIG_PATH only.
 	 *
-	 * @param string $file File name to validate.
+	 * @param string $file File name to validate [out].
 	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function ValidateFilename(&$file)
@@ -761,7 +761,7 @@ function ValidateFilename(&$file)
 	 * @param string $json JSON encoded rule array.
 	 * @param int $ruleNumber Rule number.
 	 * @param bool $force Used to override validation or other types of errors, hence forces loading of rules.
-	 * @return string Generated rule.
+	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function GeneratePfRule($json, $ruleNumber, $force= FALSE)
 	{
@@ -786,7 +786,7 @@ function GeneratePfRule($json, $ruleNumber, $force= FALSE)
 	 * @param string $json JSON encoded rules array.
 	 * @param bool $lines Whether to print line numbers in front of each line.
 	 * @param bool $force Used to override validation or other types of errors, hence forces loading of rules.
-	 * @return string Generated rules.
+	 * @return bool TRUE on success, FALSE on fail.
 	 */
 	function GeneratePfRules($json, $lines= FALSE, $force= FALSE)
 	{

src/View/lib/libwui.php

@@ -71,7 +71,7 @@ function PrintHelpBox($msg= '', $width= 300)
  * @warning $Width type should be string, because some functions use 'auto'.
  *
  * @param string $msg Message to display.
- * @param int $width Box width, defaults to auto.
+ * @param mixed $width Box width, defaults to auto.
  * @param string $type Image type to display.
  */
 function PrintHelpWindow($msg, $width= 'auto', $type= 'INFO')

src/View/pf/conf.write.php

@@ -20,9 +20,9 @@
 
 require_once ('pf.php');
 
-$printNumbers= TRUE;
+$printNumbers= 1;
 if (count($_POST) && !filter_has_var(INPUT_POST, 'numbers')) {
-	$printNumbers= FALSE;
+	$printNumbers= 0;
 }
 
 $testResult= $View->Controller($Output, 'TestPfRules', json_encode($View->RuleSet->rules));
@@ -45,8 +45,7 @@
 
 $StrRules= array();
 if ($testResult || $force) {
-	/// @todo Check why we cannot pass FALSE as numbers param
-	$generated= $View->Controller($StrRules, 'GeneratePfRules', json_encode($View->RuleSet->rules), $printNumbers ? 1 : 0, $force);
+	$generated= $View->Controller($StrRules, 'GeneratePfRules', json_encode($View->RuleSet->rules), $printNumbers, $force);
 }
 
 require_once($VIEW_PATH.'/header.php');

src/View/pf/lib/Rule.php

@@ -612,6 +612,7 @@ function inputDelEmpty($flatten= TRUE)
 	 * 
 	 * @param array $array Array to delete empty values from.
 	 * @param bool $flatten Whether to flatten arrays with single values.
+	 * @return array Converted array.
 	 */
 	function inputDelEmptyRecursive($array, $flatten)
 	{
@@ -683,7 +684,7 @@ function editCheckbox($key, $title)
 	 * @param string $key Id and name of the checkbox.
 	 * @param string $title Title for the key.
 	 * @param string $help Anchor in the html file for the pf.conf(5) man page.
-	 * @param int $size Size of the input.
+	 * @param mixed $size Size of the input, int or NULL.
 	 * @param string $hint Hint text.
 	 */
 	function editText($key, $title, $help= NULL, $size= 0, $hint= '')
@@ -715,7 +716,7 @@ function editText($key, $title, $help= NULL, $size= 0, $hint= '')
 	 * @param string $addName Id of input box.
 	 * @param string $hint Hint text.
 	 * @param string $help Anchor in the html file for the pf.conf(5) man page.
-	 * @param int $size Size of the input.
+	 * @param mixed $size Size of the input, int or NULL.
 	 * @param bool $disabled Condition to disable the input
 	 */
 	function editValues($key, $title, $delName, $addName, $hint, $help= NULL, $size= 0, $disabled= FALSE)
@@ -867,9 +868,9 @@ function editComment()
 	 * Followed by add input box.
 	 *
 	 * @param mixed $value Value for delete link, array or string.
-	 * @param string $name Get input var name, usually with a del prefix
-	 * @param string $prefix Prefix to print
-	 * @param string $postfix Postfix to print
+	 * @param string $name Get input var name, usually with a del prefix.
+	 * @param string $prefix Prefix to print.
+	 * @param string $postfix Postfix to print.
 	 */
 	function editDeleteValueLinks($value, $name, $prefix= '', $postfix= '')
 	{
@@ -904,11 +905,11 @@ function editDeleteValueLinks($value, $name, $prefix= '', $postfix= '')
 	 * Used for multi-value fields in rules.
 	 *
 	 * @param string $id Id of the input
-	 * @param string $label Label
-	 * @param string $hint Hint text
-	 * @param string $value Value instead of hint
-	 * @param int $size Size of the input
-	 * @param bool $disabled Condition to disable the input
+	 * @param mixed $label Label, string or NULL.
+	 * @param string $hint Hint text.
+	 * @param string $value Value instead of hint.
+	 * @param mixed $size Size of the input, int or NULL.
+	 * @param bool $disabled Condition to disable the input.
 	 */
 	function editAddValueBox($id, $label, $hint, $size= 0, $disabled= FALSE)
 	{

src/View/pf/lib/RuleSet.php

@@ -246,6 +246,8 @@ function computeNewRuleNumber($ruleNumber= 0)
 	 * Returns the number of a new rule to be appended to the end of the ruleset.
 	 * 
 	 * This is simply the count of the rules in the ruleset, because the list is zero-based.
+	 * 
+	 * @return int New rule number.
 	 */
 	function nextRuleNumber()
 	{
@@ -337,7 +339,7 @@ function setupEditSession($cat, &$action, &$ruleNumber)
 	 * TRUE for $assoc param, to convert objects to arrays.
 	 * 
 	 * @param int $ruleNumber The number of the rule to test.
-	 * @param object $ruleObj The rule object to test.
+	 * @param \View\Rule $ruleObj The rule object to test.
 	 * @return bool Test result returned from the Model.
 	 */
 	function test($ruleNumber, $ruleObj)
@@ -437,7 +439,8 @@ function isModified($ruleNumber, $ruleObj)
 	 * 
 	 * @return array List of queues.
 	 */
-	function getQueueNames() {
+	function getQueueNames()
+	{
 		$queues= array();
 		foreach ($this->rules as $ruleObj) {
 			if  ($ruleObj->cat == 'Queue') {