intraface / intraface.dk

src/Intraface/Kernel.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
      *
      * Used for instance in Page to give the correct submenu.
      *
-     * @return module object or false
+     * @return boolean object or false
      */
     function getPrimaryModule()
     {
@@ -167,7 +167,7 @@ 
      *
      * @param $count (integer) how many characters to return?
      *
-     * @return  random key (string) only letters
+     * @return  string key (string) only letters
      */
     function randomKey($length = 1)
     {

src/Intraface/LegacyCpdf.php

Doc Comments +59 added lines, -8 removed lines

@@ -346,7 +346,7 @@ 
     /**
      * Constructor - starts a new document
      *
-     * @param array $pageSize Array of 4 numbers, defining the bottom left and upper right corner of the page. first two are normally zero.
+     * @param integer[] $pageSize Array of 4 numbers, defining the bottom left and upper right corner of the page. first two are normally zero.
      *
      * @return void
      */
@@ -384,6 +384,8 @@ 
     /**
      * destination object, used to specify the location for the user to jump to, presently on opening
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_destination($id, $action, $options = '')
     {
@@ -421,6 +423,7 @@ 
     /**
      * sets the viewer preferences
      * @access private
+     * @param string $action
      */
     private function o_viewerPreferences($id, $action, $options = '')
     {
@@ -461,6 +464,8 @@ 
     /**
      * define the document catalog, the overall controller for the document
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_catalog($id, $action, $options = '')
     {
@@ -513,6 +518,8 @@ 
     /**
      * object which is a parent to the pages in the document
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_pages($id, $action, $options = '')
     {
@@ -633,6 +640,8 @@ 
     /**
      * defines the outlines in the doc, empty for now
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_outlines($id, $action, $options = '')
     {
@@ -665,6 +674,8 @@ 
     /**
      * an object to hold the font description
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_font($id, $action, $options = '')
     {
@@ -851,6 +862,8 @@ 
     /**
      * a font descriptor, needed for including additional fonts
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_fontDescriptor($id, $action, $options = '')
     {
@@ -904,6 +917,8 @@ 
     /**
      * the font encoding
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_fontEncoding($id, $action, $options = '')
     {
@@ -943,6 +958,7 @@ 
     /**
      * a descendent cid font, needed for unicode fonts
      * @access private
+     * @param string $action
      */
     private function o_fontDescendentCID($id, $action, $options = '')
     {
@@ -1018,6 +1034,7 @@ 
     /**
       * a font glyph to character map, needed for unicode fonts
       * @access private
+      * @param string $action
       */
     private function o_fontGIDtoCIDMap($id, $action, $options = '')
     {
@@ -1056,6 +1073,7 @@ 
     /**
      * define the document information
      * @access private
+     * @param integer $id
      */
     private function o_info($id, $action, $options = '')
     {
@@ -1102,6 +1120,8 @@ 
     /**
      * an action object, used to link to URLS initially
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_action($id, $action, $options = '')
     {
@@ -1147,6 +1167,8 @@ 
      * an annotation object, this will add an annotation to the current page.
      * initially will support just link annotations
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_annotation($id, $action, $options = '')
     {
@@ -1201,6 +1223,7 @@ 
     /**
      * a page object, it also creates a contents object to hold its contents
      * @access private
+     * @param string $action
      */
     private function o_page($id, $action, $options = '')
     {
@@ -1272,6 +1295,7 @@ 
     /**
      * the contents objects hold all of the content which appears on pages
      * @access private
+     * @param string $action
      */
     private function o_contents($id, $action, $options = '')
     {
@@ -1324,6 +1348,8 @@ 
     /**
      * an image object, will be an XObject in the document, includes description and data
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_image($id, $action, $options = '')
     {
@@ -1402,6 +1428,8 @@ 
     /**
      * encryption object.
      * @access private
+     * @param integer $id
+     * @param string $action
      */
     private function o_encryption($id, $action, $options = '')
     {
@@ -1458,8 +1486,8 @@ 
     
     /**
      * owner part of the encryption
-     * @param $owner - owner password plus padding
-     * @param $user - user password plus padding
+     * @param string $owner - owner password plus padding
+     * @param string $user - user password plus padding
      * @access private
      */
     private function encryptOwner($owner, $user)
@@ -1498,9 +1526,9 @@ 
     /**
      *
      * user part of the encryption
-     * @param $user - user password plus padding
-     * @param $ownerDict - encrypted owner entry
-     * @param $permissions - permission set (print, copy, modify, ...)
+     * @param string $user - user password plus padding
+     * @param string $ownerDict - encrypted owner entry
+     * @param string $permissions - permission set (print, copy, modify, ...)
      */
     function encryptUser($user, $ownerDict, $permissions)
     {
@@ -1563,6 +1591,9 @@ 
         return $hex;
     }
     
+    /**
+     * @param string $hex
+     */
     protected function hexToStr($hex)
     {
         $str = '';
@@ -2005,7 +2036,7 @@ 
      * @param string  $encoding Which encoding to use
      * @param integer $set      What is this
      *
-     * @return void
+     * @return integer
      * @access public
      */
     public function selectFont($fontName, $encoding = '', $set = 1, $subsetFont = false)
@@ -2331,6 +2362,11 @@ 
     /**
      * draw a part of an ellipse
      * @access public
+     * @param integer $x0
+     * @param integer $y0
+     * @param integer $astart
+     * @param integer $afinish
+     * @param integer $r1
      */
     public function partEllipse($x0, $y0, $astart, $afinish, $r1, $r2 = 0, $angle = 0, $nSeg = 8)
     {
@@ -2494,6 +2530,7 @@ 
      * draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
      * the coordinates of the upper-right corner
      * @access public
+     * @param integer $height
      */
     public function rectangle($x1, $y1, $width, $height)
     {
@@ -2593,6 +2630,7 @@ 
     /**
      * return the height in units of the current font in the given size
      * @access public
+     * @param integer $size
      */
     public function getFontHeight($size)
     {
@@ -2611,6 +2649,7 @@ 
      * if you add this number to the baseline, you get the level of the bottom of the font
      * it is in the pdf user units
      * @access public
+     * @param integer $size
      */
     public function getFontDecender($size)
     {
@@ -2775,6 +2814,8 @@ 
      * on the page the text will end
      *
      * @access protected
+     * @param integer $angle
+     * @param integer $wa
      */
     protected function getTextPosition($x, $y, $angle, $size, $wa, $text)
     {
@@ -2792,6 +2833,7 @@ 
      * wrapper function for checkTextDirective1
      *
      * @access private
+     * @param integer $f
      */
     private function checkTextDirective(&$text, $i, &$f)
     {
@@ -2808,6 +2850,7 @@ 
      * if the directive does not require a font change, then $f should be set to 0
      *
      * @access private
+     * @param integer $final
      */
     private function checkTextDirective1(&$text, $i, &$f, $final, &$x, &$y, $size = 0, $angle = 0, $wordSpaceAdjust = 0)
     {
@@ -3132,6 +3175,8 @@ 
      * do a part of the calculation for sorting out the justification of the text
      *
      * @access private
+     * @param integer $adjust
+     * @param string $justification
      */
     private function adjustWrapText($text, $actual, $width, &$x, &$adjust, $justification)
     {
@@ -3393,6 +3438,7 @@ 
     /**
      * after an object has been created, it wil only show if it has been added, using this function.
      * @access public
+     * @param integer $id
      */
     public function addObject($id, $options = 'add')
     {
@@ -3477,6 +3523,8 @@ 
      * extract an integer from a position in a byte stream
      *
      * @access private
+     * @param integer $pos
+     * @param integer $num
      */
     private function getBytes(&$data, $pos, $num)
     {
@@ -3491,7 +3539,7 @@ 
 
     /**
      * reads the PNG chunk
-     * @param $data - binary part of the png image
+     * @param string $data - binary part of the png image
      * @access private
      */
     private function readPngChunks(&$data)
@@ -3738,6 +3786,7 @@ 
     /**
      * add a JPEG image into the document, from a file
      * @access public
+     * @param string $img
      */
     public function addJpegFromFile($img, $x, $y, $w = 0, $h = 0)
     {
@@ -3870,6 +3919,7 @@ 
     /**
      * common code used by the two JPEG adding functions
      * @access private
+     * @param string $data
      */
     private function addJpegImage_common(&$data, $x, $y, $w = 0, $h = 0, $imageWidth, $imageHeight, $channels = 3)
     {
@@ -3955,6 +4005,7 @@ 
     /**
      * used to add messages for use in debugging
      * @access protected
+     * @param integer $error_type
      */
     protected function debug($message, $error_type = E_USER_NOTICE)
     {

src/Intraface/ModuleHandler.php

Doc Comments +7 added lines, -1 removed lines

@@ -39,6 +39,9 @@ 
         }
     }
 
+    /**
+     * @param string $module_name
+     */
     function setPrimaryModule($module_name)
     {
         if (!empty($this->primary_module_object) and is_object($this->primary_module_object)) {
@@ -169,8 +172,8 @@ 
     /**
      * getModule()
      *
-     * @param string $module_name
      *
+     * @param string $name
      * @return object
      */
     function getModule($name)
@@ -250,6 +253,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $name
+     */
     private static function isValidModuleName($name)
     {
         return preg_match("/^[a-z0-9]+$/", $name);

src/Intraface/modules/accounting/Account.php

Doc Comments +1 added lines, -1 removed lines

@@ -450,7 +450,7 @@
      * @param $date_from (date) yyyy-mm-dd Der s�ges jo kun i indev�rende �r
      * @param $date_to (date) yyyy-mm-dd   Der s�ges kun i indev�rende �r
      *
-     * @return (array) med debet, credit og total saldo
+     * @return boolean med debet, credit og total saldo
      *
      *
      *

src/Intraface/modules/accounting/Post.php

Doc Comments +10 added lines, -2 removed lines

@@ -36,6 +36,9 @@ 
         }
     }
 
+    /**
+     * @param integer $post_id
+     */
     public function factory($year, $post_id)
     {
         return Intraface_modules_accounting_PostGateway::getFromYearAndPostId($year, $post_id);
@@ -76,6 +79,13 @@ 
         return 1;
     }
 
+    /**
+     * @param string $date
+     * @param integer $account_id
+     * @param string $text
+     * @param double $debet
+     * @param double $credit
+     */
     private function validate($date, $account_id, $text, $debet, $credit)
     {
         $validator = new Intraface_Validator($this->error);
@@ -99,9 +109,7 @@ 
     /**
      * States the posts
      *
-     * @param integer $year_id
      * @param string  $date
-     * @param string  $voucher_number
      * @param string  $text
      * @param integer $account_id
      * @param float   $debet

src/Intraface/modules/accounting/Voucher.php

Doc Comments +1 added lines, -4 removed lines

@@ -22,7 +22,6 @@ 
      * Constructor
      *
      * @param object  $year_object
-     * @param integer $post_id (optional)
      *
      * @return void
      */
@@ -45,7 +44,7 @@ 
      * @param object $year
      * @param string $voucher_number
      *
-     * @return void
+     * @return Voucher
      */
     function factory($year, $voucher_number)
     {
@@ -339,9 +338,7 @@ 
     /**
      * Prepares amounts for stating, e.g. whether the accounts needs vat calculations
      *
-     * @param integer $year_id
      * @param string  $date
-     * @param string  $voucher_number
      * @param string  $text
      * @param integer $account_id
      * @param float   $debet

src/Intraface/modules/accounting/Year.php

Doc Comments +13 added lines, -3 removed lines

@@ -43,7 +43,7 @@ 
     /**
      * Funktion til at sætte et regnskabsår, som brugeren redigerer i.
      *
-     * @return true
+     * @return boolean
      */
     function setYear()
     {
@@ -85,7 +85,7 @@ 
      *
      * @param boolean $redirect Set to true if a redirect should occur if no year isset
      *
-     * @return boolean
+     * @return null|boolean
      */
     function checkYear($redirect = true)
     {
@@ -439,11 +439,17 @@ 
         return $this->kernel->getSetting()->set('intranet', 'accounting.'.$setting, $value, $this->get('id'));
     }
 
+    /**
+     * @param string $setting
+     */
     function getSetting($setting)
     {
         return $this->kernel->getSetting()->get('intranet', 'accounting.' . $setting, $this->get('id'));
     }
 
+    /**
+     * @param string $type
+     */
     function createAccounts($type, $last_year_id = 0)
     {
         if ($this->getId() == 0) {
@@ -742,7 +748,8 @@ 
 
     /**
      * @param $from->year (object)
-     * @param $setting (string)
+     * @param string $setting (string)
+     * @param Year $from_year
      */
     function transferAccountSetting($from_year, $setting)
     {
@@ -874,6 +881,9 @@ 
         return true;
     }
 
+    /**
+     * @return string
+     */
     public function getId()
     {
         return $this->get('id');

src/Intraface/modules/accounting/YearGateway.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
         return $account_years;
     }
 
+    /**
+     * @param string $voucher_id
+     */
     function findByVoucherId($voucher_id)
     {
         $sql = "SELECT id FROM accounting_voucher

src/Intraface/modules/cms/CKEditor.php

Doc Comments +1 added lines

@@ -468,6 +468,7 @@
 
     /**
      * Return path to ckeditor.js.
+     * @return string
      */
     private function ckeditorPath()
     {