YetiForceCompany / YetiForceCRM

include/main/WebUI.php

Doc Comments +9 added lines

@@ -54,6 +54,9 @@ 
 		return $user;
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerCheckPermission($handler, $request)
 	{
 		$moduleName = $request->getModule();
@@ -73,6 +76,9 @@ 
 		throw new \Exception\NoPermitted('LBL_NOT_ACCESSIBLE');
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerPreProcess($handler, $request)
 	{
 		if ($request->isAjax()) {
@@ -82,6 +88,9 @@ 
 		$handler->preProcess($request);
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerPostProcess($handler, $request)
 	{
 		if ($request->isAjax()) {

include/Webservices/DataTransform.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
 		return $row;
 	}
 
+	/**
+	 * @param boolean $t
+	 */
 	public static function sanitizeData($newRow, $meta, $t = null)
 	{
 

Braces +6 added lines, -4 removed lines

@@ -24,8 +24,9 @@ 
 		$fieldColumnMapping = $meta->getFieldColumnMapping();
 		$columnFieldMapping = array_flip($fieldColumnMapping);
 		foreach ($row as $col => $val) {
-			if (array_key_exists($col, $columnFieldMapping))
-				$newRow[$columnFieldMapping[$col]] = $val;
+			if (array_key_exists($col, $columnFieldMapping)) {
+							$newRow[$columnFieldMapping[$col]] = $val;
+			}
 		}
 		$newRow = DataTransform::sanitizeData($newRow, $meta, true);
 		return $newRow;
@@ -149,8 +150,9 @@ 
 		$allFields = $meta->getFieldColumnMapping();
 		$newRow = [];
 		foreach ($allFields as $field => $col) {
-			if (isset($row[$field]))
-				$newRow[$field] = $row[$field];
+			if (isset($row[$field])) {
+							$newRow[$field] = $row[$field];
+			}
 		}
 		if (isset($row[$recordString])) {
 			$newRow[$recordString] = $row[$recordString];

include/Webservices/Query.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
 
 require_once("include/Webservices/QueryParser.php");
 
+/**
+ * @param string $q
+ */
 function vtws_query($q, $user)
 {
 

Braces +3 added lines, -2 removed lines

@@ -21,8 +21,9 @@
 	// Cache the instance for re-use		
 	$moduleRegex = "/[fF][rR][Oo][Mm]\s+([^\s;]+)/";
 	$moduleName = '';
-	if (preg_match($moduleRegex, $q, $m))
-		$moduleName = trim($m[1]);
+	if (preg_match($moduleRegex, $q, $m)) {
+			$moduleName = trim($m[1]);
+	}
 
 	if (!isset($vtws_create_cache[$moduleName]['webserviceobject'])) {
 		$webserviceObject = VtigerWebserviceObject::fromQuery($adb, $q);

include/Webservices/QueryRelated.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 include_once 'include/Webservices/Query.php';
 include_once 'include/Webservices/RelatedTypes.php';
 
+/**
+ * @param string $query
+ */
 function vtws_query_related($query, $id, $relatedLabel, $user, $filterClause = null)
 {
 

Spacing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
 		if (!empty($filterClause)) {
 			$query .= " " . $filterClause;
 		}
-		$query.=";";
+		$query .= ";";
 		$relatedRecords = vtws_query($query, $user);
 	}
 

include/Webservices/VtigerActorOperation.php

Doc Comments +3 added lines

@@ -148,6 +148,9 @@
 		return false;
 	}
 
+	/**
+	 * @param string $id
+	 */
 	public function retrieve($id)
 	{
 

Spacing +1 added lines, -2 removed lines

@@ -270,8 +270,7 @@
 			foreach ($moduleFields as $fieldName => $webserviceField) {
 				array_push($fields, $this->getDescribeFieldArray($webserviceField));
 			}
-			$label = ($app_strings[$this->meta->getObectIndexColumn()]) ? $app_strings[$this->meta->getObectIndexColumn()] :
-				$this->meta->getObectIndexColumn();
+			$label = ($app_strings[$this->meta->getObectIndexColumn()]) ? $app_strings[$this->meta->getObectIndexColumn()] : $this->meta->getObectIndexColumn();
 			$this->moduleFields = $fields;
 		}
 		return $this->moduleFields;

include/Webservices/VtigerCRMActorMeta.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 	protected static $fieldTypeMapping = [];
 	protected static $referenceTypeMapping = [];
 
+	/**
+	 * @param PearDatabase $adb
+	 */
 	public function __construct($tableName, $webserviceObject, $adb, $user)
 	{
 		parent::__construct($webserviceObject, $user);

include/Webservices/VTQL_Lexer.php

Doc Comments +9 added lines

@@ -5,6 +5,9 @@ 
 $in_started = false;
 $count = false;
 
+/**
+ * @param integer $count
+ */
 function incrementN($lexer, $count)
 {
 	$i = 0;
@@ -160,6 +163,9 @@ 
 	}
 }
 
+/**
+ * @param VTQL_Lexer $lexer
+ */
 function handleend($lexer, $val)
 {
 	return VTQL_Parser::SEMICOLON;
@@ -179,6 +185,9 @@ 
 	public $mandatory;
 	public $current_state;
 
+	/**
+	 * @param string $data
+	 */
 	public function __construct($data)
 	{
 		$this->index = 0;

include/Webservices/VTQL_Parser.php

Doc Comments +3 added lines

@@ -159,6 +159,9 @@
 	private $syntax_error;
 	private $user;
 
+	/**
+	 * @param VTQL_Lexer $lex
+	 */
 	public function __construct($user, $lex, $out)
 	{
 		if (!is_array($out)) {

Spacing +6 added lines, -6 removed lines

@@ -89,7 +89,7 @@ 
 {
 
 	public $stateno; /* The state-number */
-	public $major;   /* The major token value.  This is the code
+	public $major; /* The major token value.  This is the code
 	 * * number for the token at this stack level */
 	public $minor; /* The user-supplied minor token value.  This
 	 * * is the value of the token  */
@@ -663,17 +663,17 @@ 
 	/**
 	 * @var int
 	 */
-	public $yyidx;  /* Index of top element in stack */
+	public $yyidx; /* Index of top element in stack */
 
 	/**
 	 * @var int
 	 */
-	public $yyerrcnt;  /* Shifts left before out of the error */
+	public $yyerrcnt; /* Shifts left before out of the error */
 
 	/**
 	 * @var array
 	 */
-	public $yystack = [];  /* The parser's stack */
+	public $yystack = []; /* The parser's stack */
 
 	/**
 	 * For tracing shifts, the names of all terminals and nonterminals
@@ -782,7 +782,7 @@ 
 			 * * which appear on the RHS of the rule, but which are not used
 			 * * inside the C code.
 			 */
-			default: break;   /* If no destructor action specified: do nothing */
+			default: break; /* If no destructor action specified: do nothing */
 		}
 	}
 
@@ -1608,7 +1608,7 @@ 
 	{
 //        $yyact;            /* The parser action. */
 //        $yyendofinput;     /* True if we are at the end of input */
-		$yyerrorhit = 0;   /* True if yymajor has invoked an error */
+		$yyerrorhit = 0; /* True if yymajor has invoked an error */
 
 		/* (re)initialize the parser, if necessary */
 		if ($this->yyidx === null || $this->yyidx < 0) {

libraries/SabreDAV/DAVACL/Xml/Property/Acl.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
      * the next element.
      *
      * @param Reader $reader
-     * @return mixed
+     * @return Acl
      */
     static function xmlDeserialize(Reader $reader) {
 

Spacing +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
 
         $privileges = [];
 
-        foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
+        foreach ((array) $reader->parseInnerTree($elementMap) as $element) {
 
             if ($element['name'] !== '{DAV:}ace') {
                 continue;

Braces +3 added lines, -1 removed lines

@@ -136,7 +136,9 @@
             }
             echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
             echo '<td>';
-            if (!empty($privilege['protected'])) echo '(protected)';
+            if (!empty($privilege['protected'])) {
+            	echo '(protected)';
+            }
             echo '</td>';
             echo '</tr>';
 

Indentation +246 added lines, -246 removed lines

@@ -27,251 +27,251 @@
  */
 class Acl implements Element, HtmlOutput {
 
-    /**
-     * List of privileges
-     *
-     * @var array
-     */
-    protected $privileges;
-
-    /**
-     * Whether or not the server base url is required to be prefixed when
-     * serializing the property.
-     *
-     * @var bool
-     */
-    protected $prefixBaseUrl;
-
-    /**
-     * Constructor
-     *
-     * This object requires a structure similar to the return value from
-     * Sabre\DAVACL\Plugin::getACL().
-     *
-     * Each privilege is a an array with at least a 'privilege' property, and a
-     * 'principal' property. A privilege may have a 'protected' property as
-     * well.
-     *
-     * The prefixBaseUrl should be set to false, if the supplied principal urls
-     * are already full urls. If this is kept to true, the servers base url
-     * will automatically be prefixed.
-     *
-     * @param array $privileges
-     * @param bool $prefixBaseUrl
-     */
-    public function __construct(array $privileges, $prefixBaseUrl = true) {
-
-        $this->privileges = $privileges;
-        $this->prefixBaseUrl = $prefixBaseUrl;
-
-    }
-
-    /**
-     * Returns the list of privileges for this property
-     *
-     * @return array
-     */
-    public function getPrivileges() {
-
-        return $this->privileges;
-
-    }
-
-    /**
-     * The xmlSerialize metod is called during xml writing.
-     *
-     * Use the $writer argument to write its own xml serialization.
-     *
-     * An important note: do _not_ create a parent element. Any element
-     * implementing XmlSerializble should only ever write what's considered
-     * its 'inner xml'.
-     *
-     * The parent of the current element is responsible for writing a
-     * containing element.
-     *
-     * This allows serializers to be re-used for different element names.
-     *
-     * If you are opening new elements, you must also close them again.
-     *
-     * @param Writer $writer
-     * @return void
-     */
-    public function xmlSerialize(Writer $writer) {
-
-        foreach ($this->privileges as $ace) {
-
-            $this->serializeAce($writer, $ace);
-
-        }
-
-    }
-
-    /**
-     * Generate html representation for this value.
-     *
-     * The html output is 100% trusted, and no effort is being made to sanitize
-     * it. It's up to the implementor to sanitize user provided values.
-     *
-     * The output must be in UTF-8.
-     *
-     * The baseUri parameter is a url to the root of the application, and can
-     * be used to construct local links.
-     *
-     * @param HtmlOutputHelper $html
-     * @return string
-     */
-    public function toHtml(HtmlOutputHelper $html) {
-
-        ob_start();
-        echo "<table>";
-        echo "<tr><th>Principal</th><th>Privilege</th><th></th></tr>";
-        foreach ($this->privileges as $privilege) {
-
-            echo '<tr>';
-            // if it starts with a {, it's a special principal
-            if ($privilege['principal'][0] === '{') {
-                echo '<td>', $html->xmlName($privilege['principal']), '</td>';
-            } else {
-                echo '<td>', $html->link($privilege['principal']), '</td>';
-            }
-            echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
-            echo '<td>';
-            if (!empty($privilege['protected'])) echo '(protected)';
-            echo '</td>';
-            echo '</tr>';
-
-        }
-        echo "</table>";
-        return ob_get_clean();
-
-    }
-
-    /**
-     * The deserialize method is called during xml parsing.
-     *
-     * This method is called statictly, this is because in theory this method
-     * may be used as a type of constructor, or factory method.
-     *
-     * Often you want to return an instance of the current class, but you are
-     * free to return other data as well.
-     *
-     * Important note 2: You are responsible for advancing the reader to the
-     * next element. Not doing anything will result in a never-ending loop.
-     *
-     * If you just want to skip parsing for this element altogether, you can
-     * just call $reader->next();
-     *
-     * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
-     * the next element.
-     *
-     * @param Reader $reader
-     * @return mixed
-     */
-    static function xmlDeserialize(Reader $reader) {
-
-        $elementMap = [
-            '{DAV:}ace'       => 'Sabre\Xml\Element\KeyValue',
-            '{DAV:}privilege' => 'Sabre\Xml\Element\Elements',
-            '{DAV:}principal' => 'Sabre\DAVACL\Xml\Property\Principal',
-        ];
-
-        $privileges = [];
-
-        foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
-
-            if ($element['name'] !== '{DAV:}ace') {
-                continue;
-            }
-            $ace = $element['value'];
-
-            if (empty($ace['{DAV:}principal'])) {
-                throw new DAV\Exception\BadRequest('Each {DAV:}ace element must have one {DAV:}principal element');
-            }
-            $principal = $ace['{DAV:}principal'];
-
-            switch ($principal->getType()) {
-                case Principal::HREF :
-                    $principal = $principal->getHref();
-                    break;
-                case Principal::AUTHENTICATED :
-                    $principal = '{DAV:}authenticated';
-                    break;
-                case Principal::UNAUTHENTICATED :
-                    $principal = '{DAV:}unauthenticated';
-                    break;
-                case Principal::ALL :
-                    $principal = '{DAV:}all';
-                    break;
-
-            }
-
-            $protected = array_key_exists('{DAV:}protected', $ace);
-
-            if (!isset($ace['{DAV:}grant'])) {
-                throw new DAV\Exception\NotImplemented('Every {DAV:}ace element must have a {DAV:}grant element. {DAV:}deny is not yet supported');
-            }
-            foreach ($ace['{DAV:}grant'] as $elem) {
-                if ($elem['name'] !== '{DAV:}privilege') {
-                    continue;
-                }
-
-                foreach ($elem['value'] as $priv) {
-                    $privileges[] = [
-                        'principal' => $principal,
-                        'protected' => $protected,
-                        'privilege' => $priv,
-                    ];
-                }
-
-            }
-
-        }
-
-        return new self($privileges);
-
-    }
-
-    /**
-     * Serializes a single access control entry.
-     *
-     * @param Writer $writer
-     * @param array $ace
-     * @return void
-     */
-    private function serializeAce(Writer $writer, array $ace) {
-
-        $writer->startElement('{DAV:}ace');
-
-        switch ($ace['principal']) {
-            case '{DAV:}authenticated' :
-                $principal = new Principal(Principal::AUTHENTICATED);
-                break;
-            case '{DAV:}unauthenticated' :
-                $principal = new Principal(Principal::UNAUTHENTICATED);
-                break;
-            case '{DAV:}all' :
-                $principal = new Principal(Principal::ALL);
-                break;
-            default:
-                $principal = new Principal(Principal::HREF, $ace['principal']);
-                break;
-        }
-
-        $writer->writeElement('{DAV:}principal', $principal);
-        $writer->startElement('{DAV:}grant');
-        $writer->startElement('{DAV:}privilege');
-
-        $writer->writeElement($ace['privilege']);
-
-        $writer->endElement(); // privilege
-        $writer->endElement(); // grant
-
-        if (!empty($ace['protected'])) {
-            $writer->writeElement('{DAV:}protected');
-        }
-
-        $writer->endElement(); // ace
-
-    }
+	/**
+	 * List of privileges
+	 *
+	 * @var array
+	 */
+	protected $privileges;
+
+	/**
+	 * Whether or not the server base url is required to be prefixed when
+	 * serializing the property.
+	 *
+	 * @var bool
+	 */
+	protected $prefixBaseUrl;
+
+	/**
+	 * Constructor
+	 *
+	 * This object requires a structure similar to the return value from
+	 * Sabre\DAVACL\Plugin::getACL().
+	 *
+	 * Each privilege is a an array with at least a 'privilege' property, and a
+	 * 'principal' property. A privilege may have a 'protected' property as
+	 * well.
+	 *
+	 * The prefixBaseUrl should be set to false, if the supplied principal urls
+	 * are already full urls. If this is kept to true, the servers base url
+	 * will automatically be prefixed.
+	 *
+	 * @param array $privileges
+	 * @param bool $prefixBaseUrl
+	 */
+	public function __construct(array $privileges, $prefixBaseUrl = true) {
+
+		$this->privileges = $privileges;
+		$this->prefixBaseUrl = $prefixBaseUrl;
+
+	}
+
+	/**
+	 * Returns the list of privileges for this property
+	 *
+	 * @return array
+	 */
+	public function getPrivileges() {
+
+		return $this->privileges;
+
+	}
+
+	/**
+	 * The xmlSerialize metod is called during xml writing.
+	 *
+	 * Use the $writer argument to write its own xml serialization.
+	 *
+	 * An important note: do _not_ create a parent element. Any element
+	 * implementing XmlSerializble should only ever write what's considered
+	 * its 'inner xml'.
+	 *
+	 * The parent of the current element is responsible for writing a
+	 * containing element.
+	 *
+	 * This allows serializers to be re-used for different element names.
+	 *
+	 * If you are opening new elements, you must also close them again.
+	 *
+	 * @param Writer $writer
+	 * @return void
+	 */
+	public function xmlSerialize(Writer $writer) {
+
+		foreach ($this->privileges as $ace) {
+
+			$this->serializeAce($writer, $ace);
+
+		}
+
+	}
+
+	/**
+	 * Generate html representation for this value.
+	 *
+	 * The html output is 100% trusted, and no effort is being made to sanitize
+	 * it. It's up to the implementor to sanitize user provided values.
+	 *
+	 * The output must be in UTF-8.
+	 *
+	 * The baseUri parameter is a url to the root of the application, and can
+	 * be used to construct local links.
+	 *
+	 * @param HtmlOutputHelper $html
+	 * @return string
+	 */
+	public function toHtml(HtmlOutputHelper $html) {
+
+		ob_start();
+		echo "<table>";
+		echo "<tr><th>Principal</th><th>Privilege</th><th></th></tr>";
+		foreach ($this->privileges as $privilege) {
+
+			echo '<tr>';
+			// if it starts with a {, it's a special principal
+			if ($privilege['principal'][0] === '{') {
+				echo '<td>', $html->xmlName($privilege['principal']), '</td>';
+			} else {
+				echo '<td>', $html->link($privilege['principal']), '</td>';
+			}
+			echo '<td>', $html->xmlName($privilege['privilege']), '</td>';
+			echo '<td>';
+			if (!empty($privilege['protected'])) echo '(protected)';
+			echo '</td>';
+			echo '</tr>';
+
+		}
+		echo "</table>";
+		return ob_get_clean();
+
+	}
+
+	/**
+	 * The deserialize method is called during xml parsing.
+	 *
+	 * This method is called statictly, this is because in theory this method
+	 * may be used as a type of constructor, or factory method.
+	 *
+	 * Often you want to return an instance of the current class, but you are
+	 * free to return other data as well.
+	 *
+	 * Important note 2: You are responsible for advancing the reader to the
+	 * next element. Not doing anything will result in a never-ending loop.
+	 *
+	 * If you just want to skip parsing for this element altogether, you can
+	 * just call $reader->next();
+	 *
+	 * $reader->parseInnerTree() will parse the entire sub-tree, and advance to
+	 * the next element.
+	 *
+	 * @param Reader $reader
+	 * @return mixed
+	 */
+	static function xmlDeserialize(Reader $reader) {
+
+		$elementMap = [
+			'{DAV:}ace'       => 'Sabre\Xml\Element\KeyValue',
+			'{DAV:}privilege' => 'Sabre\Xml\Element\Elements',
+			'{DAV:}principal' => 'Sabre\DAVACL\Xml\Property\Principal',
+		];
+
+		$privileges = [];
+
+		foreach ((array)$reader->parseInnerTree($elementMap) as $element) {
+
+			if ($element['name'] !== '{DAV:}ace') {
+				continue;
+			}
+			$ace = $element['value'];
+
+			if (empty($ace['{DAV:}principal'])) {
+				throw new DAV\Exception\BadRequest('Each {DAV:}ace element must have one {DAV:}principal element');
+			}
+			$principal = $ace['{DAV:}principal'];
+
+			switch ($principal->getType()) {
+				case Principal::HREF :
+					$principal = $principal->getHref();
+					break;
+				case Principal::AUTHENTICATED :
+					$principal = '{DAV:}authenticated';
+					break;
+				case Principal::UNAUTHENTICATED :
+					$principal = '{DAV:}unauthenticated';
+					break;
+				case Principal::ALL :
+					$principal = '{DAV:}all';
+					break;
+
+			}
+
+			$protected = array_key_exists('{DAV:}protected', $ace);
+
+			if (!isset($ace['{DAV:}grant'])) {
+				throw new DAV\Exception\NotImplemented('Every {DAV:}ace element must have a {DAV:}grant element. {DAV:}deny is not yet supported');
+			}
+			foreach ($ace['{DAV:}grant'] as $elem) {
+				if ($elem['name'] !== '{DAV:}privilege') {
+					continue;
+				}
+
+				foreach ($elem['value'] as $priv) {
+					$privileges[] = [
+						'principal' => $principal,
+						'protected' => $protected,
+						'privilege' => $priv,
+					];
+				}
+
+			}
+
+		}
+
+		return new self($privileges);
+
+	}
+
+	/**
+	 * Serializes a single access control entry.
+	 *
+	 * @param Writer $writer
+	 * @param array $ace
+	 * @return void
+	 */
+	private function serializeAce(Writer $writer, array $ace) {
+
+		$writer->startElement('{DAV:}ace');
+
+		switch ($ace['principal']) {
+			case '{DAV:}authenticated' :
+				$principal = new Principal(Principal::AUTHENTICATED);
+				break;
+			case '{DAV:}unauthenticated' :
+				$principal = new Principal(Principal::UNAUTHENTICATED);
+				break;
+			case '{DAV:}all' :
+				$principal = new Principal(Principal::ALL);
+				break;
+			default:
+				$principal = new Principal(Principal::HREF, $ace['principal']);
+				break;
+		}
+
+		$writer->writeElement('{DAV:}principal', $principal);
+		$writer->startElement('{DAV:}grant');
+		$writer->startElement('{DAV:}privilege');
+
+		$writer->writeElement($ace['privilege']);
+
+		$writer->endElement(); // privilege
+		$writer->endElement(); // grant
+
+		if (!empty($ace['protected'])) {
+			$writer->writeElement('{DAV:}protected');
+		}
+
+		$writer->endElement(); // ace
+
+	}
 
 }