seblucas / cops

customcolumn.php

Doc Comments +31 added lines, -1 removed lines

@@ -128,6 +128,9 @@ 
     /** @var null|Entry[] */
     private $customValues = NULL;
 
+    /**
+     * @param string $pdatatype
+     */
     protected function __construct($pcustomId, $pdatatype)
     {
         $this->columnTitle = self::getTitleByCustomID($pcustomId);
@@ -236,7 +239,7 @@ 
     /**
      * Encode a value of this column ready to be displayed in an HTML document
      *
-     * @param integer|string $value
+     * @param string $value
      * @return string
      */
     public function encodeHTMLValue($value)
@@ -404,6 +407,9 @@ 
 
 class CustomColumnTypeText extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_TEXT);
@@ -502,6 +508,9 @@ 
 
 class CustomColumnTypeSeries extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_SERIES);
@@ -597,6 +606,9 @@ 
 
 class CustomColumnTypeEnumeration extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_ENUM);
@@ -692,6 +704,9 @@ 
 
 class CustomColumnTypeDate extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_DATE);
@@ -772,6 +787,9 @@ 
 
 class CustomColumnTypeRating extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_RATING);
@@ -882,6 +900,9 @@ 
         +1 => "customcolumn.boolean.yes",     // localize("customcolumn.boolean.yes")
     );
 
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_BOOL);
@@ -962,6 +983,9 @@ 
 
 class CustomColumnTypeInteger extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_INT);
@@ -1033,6 +1057,9 @@ 
 
 class CustomColumnTypeFloat extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_FLOAT);
@@ -1104,6 +1131,9 @@ 
 
 class CustomColumnTypeComment extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_COMMENT);

base.php

Doc Comments +48 added lines

@@ -60,6 +60,9 @@ 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
+/**
+ * @param string $name
+ */
 function getURLParam ($name, $default = NULL) {
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
         return $_GET[$name];
@@ -95,6 +98,11 @@ 
     return $url . "?v=" . VERSION;
 }
 
+/**
+ * @param string $xml
+ *
+ * @return string
+ */
 function xml2xhtml($xml) {
     return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', create_function('$m', '
         $xhtml_tags = array("br", "hr", "input", "frame", "img", "area", "link", "col", "base", "basefont", "param");
@@ -308,6 +316,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue) {
     if (empty ($urlParams)) {
         $urlParams = "";
@@ -369,6 +380,9 @@ 
         return $this->href;
     }
 
+    /**
+     * @return string
+     */
     public function getScriptName() {
         $parts = explode('/', $_SERVER["SCRIPT_NAME"]);
         return $parts[count($parts) - 1];
@@ -377,6 +391,9 @@ 
 
 class LinkNavigation extends Link
 {
+    /**
+     * @param string $prel
+     */
     public function __construct($phref, $prel = NULL, $ptitle = NULL) {
         parent::__construct ($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);
         if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
@@ -391,6 +408,9 @@ 
 
 class LinkFacet extends Link
 {
+    /**
+     * @param string $phref
+     */
     public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
         parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
         if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
@@ -445,6 +465,9 @@ 
         return "#";
     }
 
+    /**
+     * @param string $pcontentType
+     */
     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0) {
         global $config;
         $this->title = $ptitle;
@@ -1111,6 +1134,9 @@ 
 
 class PageCustomize extends Page
 {
+    /**
+     * @param string $key
+     */
     private function isChecked ($key, $testedValue = 1) {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
@@ -1125,6 +1151,9 @@ 
         return "";
     }
 
+    /**
+     * @param string $key
+     */
     private function isSelected ($key, $value) {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";
@@ -1271,6 +1300,9 @@ 
         }
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getDbName ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -1284,6 +1316,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -1347,6 +1382,12 @@ 
         return self::getDb ($database)->query($query)->fetchColumn();
     }
 
+    /**
+     * @param string $table
+     * @param string $id
+     * @param string $numberOfString
+     * @param string $sql
+     */
     public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL, $sql = NULL) {
         if (!$numberOfString) {
             $numberOfString = $table . ".alphabetical";
@@ -1363,6 +1404,10 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $columns
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
         /* @var $result PDOStatement */
 
@@ -1385,6 +1430,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL, $max = NULL) {
         $totalResult = -1;