mambax7 / smartobject

class/adsense.php

Doc Comments +3 added lines

@@ -78,6 +78,9 @@
         						'maxlength' => 6));
     }
 
+    /**
+     * @param string $key
+     */
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array())) {
             return call_user_func(array($this,$key));

class/currency.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 		$this->hideFieldFromForm('default_currency');
     }
 
+    /**
+     * @param string $key
+     */
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array('rate', 'default_currency'))) {
             return call_user_func(array($this,$key));

Spacing +3 added lines, -3 removed lines

@@ -31,12 +31,12 @@ 
     die("XOOPS root path not defined");
 }
 
-include_once XOOPS_ROOT_PATH."/modules/smartobject/class/smartobject.php";
+include_once XOOPS_ROOT_PATH . "/modules/smartobject/class/smartobject.php";
 include_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
 
 class SmartobjectCurrency extends SmartObject {
 
-	var $_modulePlugin=false;
+	var $_modulePlugin = false;
 
     function SmartobjectCurrency() {
         $this->quickInitVar('currencyid', XOBJ_DTYPE_INT, true);
@@ -75,7 +75,7 @@ 
 
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array('rate', 'default_currency'))) {
-            return call_user_func(array($this,$key));
+            return call_user_func(array($this, $key));
         }
         return parent::getVar($key, $format);
     }

class/customtag.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
 
     }
 
+    /**
+     * @param string $key
+     */
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array())) {
             return call_user_func(array($this,$key));

class/form/elements/smartformset_passwordelement.php

Doc Comments -6 removed lines

@@ -39,12 +39,6 @@
 	/**
 	 * Constructor
 	 *
-	 * @param	string	$caption	Caption
-	 * @param	string	$name		"name" attribute
-	 * @param	int		$size		Size of the field
-	 * @param	int		$maxlength	Maximum length of the text
-	 * @param	int		$value		Initial value of the field.
-	 * 								<b>Warning:</b> this is readable in cleartext in the page's source!
 	 */
 	function SmartFormSet_passwordElement($object, $key){
 

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 * @param	int		$value		Initial value of the field.
 	 * 								<b>Warning:</b> this is readable in cleartext in the page's source!
 	 */
-	function SmartFormSet_passwordElement($object, $key){
+	function SmartFormSet_passwordElement($object, $key) {
 
 	    $var = $object->vars[$key];
 	    $control = $object->controls[$key];

class/form/elements/smartformtextelement.php

Doc Comments +4 added lines

@@ -11,6 +11,10 @@
  * @subpackage SmartObjectForm
  */
 class SmartFormTextElement extends XoopsFormText {
+
+    /**
+     * @param string $key
+     */
     function SmartFormTextElement($object, $key) {
 		$var = $object->vars[$key];
 

Spacing +3 added lines, -3 removed lines

@@ -14,12 +14,12 @@
     function SmartFormTextElement($object, $key) {
 		$var = $object->vars[$key];
 
-		if(isset($object->controls[$key])){
+		if (isset($object->controls[$key])) {
 			$control = $object->controls[$key];
 	        $form_maxlength = isset($control['maxlength']) ? $control['maxlength'] : (isset($var['maxlength']) ? $var['maxlength'] : 255);
 			$form_size = isset($control['size']) ? $control['size'] : 50;
-		}else{
-			$form_maxlength =  255;
+		} else {
+			$form_maxlength = 255;
 			$form_size = 50;
 		}
 

class/form/smartobjectform.php

Doc Comments +5 added lines, -1 removed lines

@@ -42,6 +42,10 @@ 
     var $_form_caption=false;
     var $_submit_button_caption=false;
 
+    /**
+     * @param SmartObject $target
+     * @param boolean $form_action
+     */
     function SmartobjectForm(&$target, $form_name, $form_caption, $form_action, $form_fields=null, $submit_button_caption = false, $cancel_js_action=false, $captcha=false) {
 
         $this->targetObject =& $target;
@@ -88,7 +92,7 @@ 
      * Add an element to the form
      *
      * @param	object  &$formElement    reference to a {@link XoopsFormElement}
-     * @param	bool    $required       is this a "required" element?
+     * @param	string|boolean    $required       is this a "required" element?
      */
     function addElement(&$formElement, $key=false, $var=false, $required='notset'){
         if ($key) {

Spacing +78 added lines, -78 removed lines

@@ -35,28 +35,28 @@ 
 
     var $targetObject = null;
     var $form_fields = null;
-    var $_cancel_js_action=false;
-    var $_custom_button=false;
-    var $_captcha=false;
-    var $_form_name=false;
-    var $_form_caption=false;
-    var $_submit_button_caption=false;
+    var $_cancel_js_action = false;
+    var $_custom_button = false;
+    var $_captcha = false;
+    var $_form_name = false;
+    var $_form_caption = false;
+    var $_submit_button_caption = false;
 
-    function SmartobjectForm(&$target, $form_name, $form_caption, $form_action, $form_fields=null, $submit_button_caption = false, $cancel_js_action=false, $captcha=false) {
+    function SmartobjectForm(&$target, $form_name, $form_caption, $form_action, $form_fields = null, $submit_button_caption = false, $cancel_js_action = false, $captcha = false) {
 
-        $this->targetObject =& $target;
+        $this->targetObject = & $target;
         $this->form_fields = $form_fields;
         $this->_cancel_js_action = $cancel_js_action;
-        $this->_captcha= $captcha;
-        $this->_form_name= $form_name;
-        $this->_form_caption= $form_caption;
-        $this->_submit_button_caption= $submit_button_caption;
+        $this->_captcha = $captcha;
+        $this->_form_name = $form_name;
+        $this->_form_caption = $form_caption;
+        $this->_submit_button_caption = $submit_button_caption;
 
         if (!isset($form_action)) {
             $form_action = xoops_getenv('PHP_SELF');
         }
 
-        $this->XoopsForm( $form_caption, $form_name, $form_action);
+        $this->XoopsForm($form_caption, $form_name, $form_action);
         $this->setExtra('enctype="multipart/form-data"');
 
         $this->createElements();
@@ -75,7 +75,7 @@ 
         $this->addElement(new XoopsFormCaptcha(), true);
     }
 
-    function addCustomButton($name, $caption, $onclick=false) {
+    function addCustomButton($name, $caption, $onclick = false) {
         $custom_button_array = array(
 						'name' => $name,
 						'caption' => $caption,
@@ -90,7 +90,7 @@ 
      * @param	object  &$formElement    reference to a {@link XoopsFormElement}
      * @param	bool    $required       is this a "required" element?
      */
-    function addElement(&$formElement, $key=false, $var=false, $required='notset'){
+    function addElement(&$formElement, $key = false, $var = false, $required = 'notset') {
         if ($key) {
             if ($this->targetObject->vars[$key]['readonly']) {
                 $formElement->setExtra('disabled="disabled"');
@@ -112,7 +112,7 @@ 
                 }
             }
             $controls = $this->targetObject->controls;
-            if(isset($controls[$key]['js'])){
+            if (isset($controls[$key]['js'])) {
                 $formElement->customValidationCode[] = $controls[$key]['js'];
             }
             parent::AddElement($formElement, $required == 'notset' ? $var['required'] : $required);
@@ -268,7 +268,7 @@ 
             $member_handler = &xoops_gethandler('member');
             $group_list = $member_handler->getGroupList();
             asort($group_list);
-            foreach($permissions as $permission) {
+            foreach ($permissions as $permission) {
                 if ($this->targetObject->isNew()) {
                     if (isset($smartModuleConfig['def_perm_' . $permission['perm_name']])) {
                         $groups_value = $smartModuleConfig['def_perm_' . $permission['perm_name']];
@@ -289,7 +289,7 @@ 
 
         $button_tray = new XoopsFormElementTray('', '');
         $button_tray->addElement(new XoopsFormHidden('op', $form_name));
-        if(!$submit_button_caption){
+        if (!$submit_button_caption) {
             if ($this->targetObject->isNew()) {
                 $butt_create = new XoopsFormButton('', 'create_button', _CO_SOBJECT_CREATE, 'submit');
             } else {
@@ -297,14 +297,14 @@ 
             }
         }
         else {
-            $butt_create = new XoopsFormButton('', 'modify_button', $submit_button_caption , 'submit');
+            $butt_create = new XoopsFormButton('', 'modify_button', $submit_button_caption, 'submit');
         }
         $butt_create->setExtra('onclick="this.form.elements.op.value=\'' . $form_name . '\'"');
         $button_tray->addElement($butt_create);
 
         //creating custom buttons
         if ($this->_custom_button) {
-            foreach($this->_custom_button as $custom_button) {
+            foreach ($this->_custom_button as $custom_button) {
                 $butt_custom = new XoopsFormButton('', $custom_button['name'], $custom_button['caption'], 'submit');
                 if ($custom_button['onclick']) {
                     $butt_custom->setExtra('onclick="' . $custom_button['onclick'] . '"');
@@ -329,7 +329,7 @@ 
     function getControl($controlName, $key) {
         switch ($controlName) {
             case 'check':
-                include_once(SMARTOBJECT_ROOT_PATH."class/form/elements/smartformcheckelement.php");
+                include_once(SMARTOBJECT_ROOT_PATH . "class/form/elements/smartformcheckelement.php");
                 $control = $this->targetObject->getControl($key);
                 $controlObj = new SmartFormCheckElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));
                 $controlObj->addOptionArray($control['options']);
@@ -393,36 +393,36 @@ 
                 break;
 
             case 'urllink':
-                include_once(SMARTOBJECT_ROOT_PATH."class/form/elements/smartformurllinkelement.php");
+                include_once(SMARTOBJECT_ROOT_PATH . "class/form/elements/smartformurllinkelement.php");
                 return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));
                 break;
 
             case 'richfile':
-                include_once(SMARTOBJECT_ROOT_PATH."class/form/elements/smartformrichfileelement.php");
+                include_once(SMARTOBJECT_ROOT_PATH . "class/form/elements/smartformrichfileelement.php");
                 return new SmartFormRichFileElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getFileObj($key));
                 break;
             case 'section':
-                include_once(SMARTOBJECT_ROOT_PATH."class/form/elements/smartformsection.php");
+                include_once(SMARTOBJECT_ROOT_PATH . "class/form/elements/smartformsection.php");
                 return new SmartFormSection($key, $this->targetObject->vars[$key]['form_caption']);
                 break;
 
 
             default:
-                $classname = "SmartForm".ucfirst($controlName)."Element";
+                $classname = "SmartForm" . ucfirst($controlName) . "Element";
                 if (!class_exists($classname)) {
-                    if (file_exists(SMARTOBJECT_ROOT_PATH."class/form/elements/".strtolower($classname).".php")) {
-                        include_once(SMARTOBJECT_ROOT_PATH."class/form/elements/".strtolower($classname).".php");
+                    if (file_exists(SMARTOBJECT_ROOT_PATH . "class/form/elements/" . strtolower($classname) . ".php")) {
+                        include_once(SMARTOBJECT_ROOT_PATH . "class/form/elements/" . strtolower($classname) . ".php");
                     } else {
                         // perhaps this is a control created by the module
                         $moduleName = $this->targetObject->handler->_moduleName;
                         $moduleFormElementsPath = $this->targetObject->handler->_modulePath . 'class/form/elements/';
                         $classname = ucfirst($moduleName) . ucfirst($controlName) . "Element";
-                        $classFileName = strtolower($classname).".php";
+                        $classFileName = strtolower($classname) . ".php";
 
                         if (file_exists($moduleFormElementsPath . $classFileName)) {
                             include_once($moduleFormElementsPath . $classFileName);
                         } else {
-                            trigger_error($classname." Not found", E_USER_WARNING);
+                            trigger_error($classname . " Not found", E_USER_WARNING);
                             return new XoopsFormLabel(); //Empty object
                         }
                     }
@@ -463,7 +463,7 @@ 
 
         $value = $this->targetObject->getValueFor($key, true);
 
-        $editor_configs=array();
+        $editor_configs = array();
         $editor_configs["name"] = $name;
         $editor_configs["value"] = $value;
         if ($form_editor != 'textarea') {
@@ -489,13 +489,13 @@ 
             $editor = new XoopsFormEditor($caption, $form_editor, $editor_configs, $nohtml = false, $onfailure = "textarea");
         } else {
 
-            switch($form_editor) {
+            switch ($form_editor) {
 
                 case 'tiny' :
                     if (!$xoops22) {
-                        if ( is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/tinyeditor/formtinytextarea.php"))	{
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/tinyeditor/formtinytextarea.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/xoopseditor/tinyeditor/formtinytextarea.php");
-                            $editor = new XoopsFormTinyTextArea(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'),true);
+                            $editor = new XoopsFormTinyTextArea(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'), true);
                         } else {
                             if ($dhtml) {
                                 $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
@@ -518,9 +518,9 @@ 
 
                 case 'fckeditor' :
                     if (!$xoops22) {
-                        if ( is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/fckeditor/formfckeditor.php"))	{
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/fckeditor/formfckeditor.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/xoopseditor/fckeditor/formfckeditor.php");
-                            $editor = new XoopsFormFckeditor(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'),true);
+                            $editor = new XoopsFormFckeditor(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'), true);
                         } else {
                             if ($dhtml) {
                                 $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
@@ -535,9 +535,9 @@ 
 
                 case 'inbetween' :
                     if (!$xoops22) {
-                        if ( is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/inbetween/forminbetweentextarea.php"))	{
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/xoopseditor/inbetween/forminbetweentextarea.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/xoopseditor/inbetween/forminbetweentextarea.php");
-                            $editor = new XoopsFormInbetweenTextArea(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'),true);
+                            $editor = new XoopsFormInbetweenTextArea(array('caption'=> $caption, 'name'=>$name, 'value'=>$value, 'width'=>'100%', 'height'=>'300px'), true);
                         } else {
                             if ($dhtml) {
                                 $editor = new XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
@@ -552,7 +552,7 @@ 
 
                 case 'koivi' :
                     if (!$xoops22) {
-                        if ( is_readable(XOOPS_ROOT_PATH . "/class/wysiwyg/formwysiwygtextarea.php"))	{
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/wysiwyg/formwysiwygtextarea.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/wysiwyg/formwysiwygtextarea.php");
                             $editor = new XoopsFormWysiwygTextArea($caption, $name, $value, '100%', '400px');
                         } else {
@@ -568,8 +568,8 @@ 
                     break;
 
                 case "spaw":
-                    if(!$xoops22) {
-                        if (is_readable(XOOPS_ROOT_PATH . "/class/spaw/formspaw.php"))	{
+                    if (!$xoops22) {
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/spaw/formspaw.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/spaw/formspaw.php");
                             $editor = new XoopsFormSpaw($caption, $name, $value);
                         }
@@ -579,8 +579,8 @@ 
                     break;
 
                 case "htmlarea":
-                    if(!$xoops22) {
-                        if ( is_readable(XOOPS_ROOT_PATH . "/class/htmlarea/formhtmlarea.php"))	{
+                    if (!$xoops22) {
+                        if (is_readable(XOOPS_ROOT_PATH . "/class/htmlarea/formhtmlarea.php")) {
                             include_once(XOOPS_ROOT_PATH . "/class/htmlarea/formhtmlarea.php");
                             $editor = new XoopsFormHtmlarea($caption, $name, $value);
                         }
@@ -606,16 +606,16 @@ 
         return $editor;
     }
 
-    function getThemeSelect($key, $var, $multiple=false) {
+    function getThemeSelect($key, $var, $multiple = false) {
 
         $size = $multiple ? 5 : 1;
         $theme_select = new XoopsFormSelect($var['form_caption'], $key, $this->targetObject->getVar($key), $size, $multiple);
 
-        $handle = opendir(XOOPS_THEME_PATH.'/');
+        $handle = opendir(XOOPS_THEME_PATH . '/');
         $dirlist = array();
         while (false !== ($file = readdir($handle))) {
-            if (is_dir(XOOPS_THEME_PATH.'/'.$file) && !preg_match("/^[.]{1,2}$/",$file) && strtolower($file) != 'cvs') {
-                $dirlist[$file]=$file;
+            if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match("/^[.]{1,2}$/", $file) && strtolower($file) != 'cvs') {
+                $dirlist[$file] = $file;
             }
         }
         closedir($handle);
@@ -630,7 +630,7 @@ 
     function &getElementById($keyname) {
         foreach ($this->_elements as $eleObj) {
             if ($eleObj->getName() == $keyname) {
-                $ret =& $eleObj;
+                $ret = & $eleObj;
                 break;
             }
         }
@@ -644,30 +644,30 @@ 
      */
     function render()
     {
-        $required =& $this->getRequired();
+        $required = & $this->getRequired();
         $ret = "
-			<form name='".$this->getName()."' id='".$this->getName()."' action='".$this->getAction()."' method='".$this->getMethod()."' onsubmit='return xoopsFormValidate_".$this->getName()."(this);'".$this->getExtra().">
+			<form name='".$this->getName() . "' id='" . $this->getName() . "' action='" . $this->getAction() . "' method='" . $this->getMethod() . "' onsubmit='return xoopsFormValidate_" . $this->getName() . "(this);'" . $this->getExtra() . ">
 			<table width='100%' class='outer' cellspacing='1'>
-			<tr><th colspan='2'>".$this->getTitle()."</th></tr>
+			<tr><th colspan='2'>".$this->getTitle() . "</th></tr>
 		";
         $hidden = '';
-        $class ='even';
-        foreach ( $this->getElements() as $ele ) {
+        $class = 'even';
+        foreach ($this->getElements() as $ele) {
             if (!is_object($ele)) {
                 $ret .= $ele;
-            } elseif ( !$ele->isHidden() ) {
+            } elseif (!$ele->isHidden()) {
                 //$class = ( $class == 'even' ) ? 'odd' : 'even';
-                $ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>".$ele->getCaption();
+                $ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>" . $ele->getCaption();
                 if ($ele->getDescription() != '') {
-                    $ret .= '<br /><br /><span style="font-weight: normal;">'.$ele->getDescription().'</span>';
+                    $ret .= '<br /><br /><span style="font-weight: normal;">' . $ele->getDescription() . '</span>';
                 }
-                $ret .= "</td><td class='$class'>".$ele->render()."</td></tr>\n";
+                $ret .= "</td><td class='$class'>" . $ele->render() . "</td></tr>\n";
             } else {
                 $hidden .= $ele->render();
             }
         }
         $ret .= "</table>\n$hidden\n</form>\n";
-        $ret .= $this->renderValidationJS( true );
+        $ret .= $this->renderValidationJS(true);
         return $ret;
     }
 
@@ -677,20 +677,20 @@ 
      * @param	object  &$tpl    reference to a {@link Smarty} object
      * @see     Smarty
      */
-    function assign(&$tpl, $smartyName=false){
+    function assign(&$tpl, $smartyName = false) {
         $i = 0;
         $elements = array();
-        foreach ( $this->getElements() as $ele ) {
+        foreach ($this->getElements() as $ele) {
             $n = ($ele->getName() != "") ? $ele->getName() : $i;
             $elements[$n]['name']	  = $ele->getName();
             $elements[$n]['caption']  = $ele->getCaption();
             $elements[$n]['body']	  = $ele->render();
             $elements[$n]['hidden']	  = $ele->isHidden();
             $elements[$n]['section']  = strToLower(get_class($ele)) == strToLower('SmartFormSection');
-            $elements[$n]['section_close']  = get_class($ele) == 'SmartFormSectionClose';
+            $elements[$n]['section_close'] = get_class($ele) == 'SmartFormSectionClose';
             $elements[$n]['hide'] = isset($this->targetObject->vars[$n]['hide']) ? $this->targetObject->vars[$n]['hide'] : false;
             if ($ele->getDescription() != '') {
-                $elements[$n]['description']  = $ele->getDescription();
+                $elements[$n]['description'] = $ele->getDescription();
             }
             $i++;
         }
@@ -699,25 +699,25 @@ 
             $smartyName = $this->getName();
         }
 
-        $tpl->assign($smartyName, array('title' => $this->getTitle(), 'name' => $this->getName(), 'action' => $this->getAction(),  'method' => $this->getMethod(), 'extra' => 'onsubmit="return xoopsFormValidate_'.$this->getName().'(this);"'.$this->getExtra(), 'javascript' => $js, 'elements' => $elements));
+        $tpl->assign($smartyName, array('title' => $this->getTitle(), 'name' => $this->getName(), 'action' => $this->getAction(), 'method' => $this->getMethod(), 'extra' => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '(this);"' . $this->getExtra(), 'javascript' => $js, 'elements' => $elements));
     }
 
 
-    function renderValidationJS( $withtags = true ) {
+    function renderValidationJS($withtags = true) {
         $js = "";
-        if ( $withtags ) {
+        if ($withtags) {
             $js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
         }
-        $myts =& MyTextSanitizer::getInstance();
+        $myts = & MyTextSanitizer::getInstance();
         $formname = $this->getName();
         $js .= "function xoopsFormValidate_{$formname}(myform) {";
         // First, output code to check required elements
         $elements = $this->getRequired();
-        foreach ( $elements as $elt ) {
+        foreach ($elements as $elt) {
             $eltname    = $elt->getName();
-            $eltcaption = trim( $elt->getCaption() );
-            $eltmsg = empty($eltcaption) ? sprintf( _FORM_ENTER, $eltname ) : sprintf( _FORM_ENTER, $eltcaption );
-            $eltmsg = str_replace('"', '\"', stripslashes( $eltmsg ) );
+            $eltcaption = trim($elt->getCaption());
+            $eltmsg = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
+            $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
             if (strtolower(get_class($elt)) == 'xoopsformradio') {
                 $js .= "var myOption = -1;";
                 $js .= "for (i=myform.{$eltname}.length-1; i > -1; i--) {
@@ -739,10 +739,10 @@ 
 				if (hasSelections == false) {
 					window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'].options[0].focus(); return false; }\n";
 
-            }elseif (strtolower(get_class($elt)) == 'xoopsformcheckbox' || strtolower(get_class($elt)) == 'smartformcheckelement' ) {
+            }elseif (strtolower(get_class($elt)) == 'xoopsformcheckbox' || strtolower(get_class($elt)) == 'smartformcheckelement') {
                 $js .= "var hasSelections = false;";
                 //sometimes, there is an implicit '[]', sometimes not
-                if(strpos($eltname, '[') === false){
+                if (strpos($eltname, '[') === false) {
                     $js .= "for(var i = 0; i < myform['{$eltname}[]'].length; i++){
 						if (myform['{$eltname}[]'][i].checked) {
 							hasSelections = true;
@@ -751,7 +751,7 @@ 
 					}
 					if (hasSelections == false) {
 						window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'][0].focus(); return false; }\n";
-                }else{
+                } else {
                     $js .= "for(var i = 0; i < myform['{$eltname}'].length; i++){
 						if (myform['{$eltname}'][i].checked) {
 							hasSelections = true;
@@ -762,22 +762,22 @@ 
 						window.alert(\"{$eltmsg}\"); myform['{$eltname}'][0].focus(); return false; }\n";
                 }
 
-            }else{
+            } else {
                 $js .= "if ( myform.{$eltname}.value == \"\" ) "
                 . "{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
             }
         }
         // Now, handle custom validation code
-        $elements = $this->getElements( true );
-        foreach ( $elements as $elt ) {
-            if ( method_exists( $elt, 'renderValidationJS') && strtolower(get_class($elt)) != 'xoopsformcheckbox') {
-                if ( $eltjs = $elt->renderValidationJS() ) {
+        $elements = $this->getElements(true);
+        foreach ($elements as $elt) {
+            if (method_exists($elt, 'renderValidationJS') && strtolower(get_class($elt)) != 'xoopsformcheckbox') {
+                if ($eltjs = $elt->renderValidationJS()) {
                     $js .= $eltjs . "\n";
                 }
             }
         }
         $js .= "return true;\n}\n";
-        if ( $withtags ) {
+        if ($withtags) {
             $js .= "//--></script>\n<!-- End Form Vaidation JavaScript //-->\n";
         }
         return $js;

class/rating.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
         						'method' => 'getRateList'));
     }
 
+    /**
+     * @param string $key
+     */
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array('name', 'dirname'))) {
             return call_user_func(array($this,$key));

Spacing +11 added lines, -11 removed lines

@@ -31,12 +31,12 @@ 
     die("XOOPS root path not defined");
 }
 
-include_once XOOPS_ROOT_PATH."/modules/smartobject/class/smartobject.php";
-include_once XOOPS_ROOT_PATH."/modules/smartobject/class/smartplugins.php";
+include_once XOOPS_ROOT_PATH . "/modules/smartobject/class/smartobject.php";
+include_once XOOPS_ROOT_PATH . "/modules/smartobject/class/smartplugins.php";
 
 class SmartobjectRating extends SmartObject {
 
-	var $_modulePlugin=false;
+	var $_modulePlugin = false;
 
     function SmartobjectRating() {
         $this->quickInitVar('ratingid', XOBJ_DTYPE_INT, true);
@@ -67,7 +67,7 @@ 
 
     function getVar($key, $format = 's') {
         if ($format == 's' && in_array($key, array('name', 'dirname'))) {
-            return call_user_func(array($this,$key));
+            return call_user_func(array($this, $key));
         }
         return parent::getVar($key, $format);
     }
@@ -115,8 +115,8 @@ 
 }
 class SmartobjectRatingHandler extends SmartPersistableObjectHandler {
 
-	var $_rateOptions=array();
-	var $_moduleList=false;
+	var $_rateOptions = array();
+	var $_moduleList = false;
 	var $pluginsObject;
 
     function SmartobjectRatingHandler($db) {
@@ -158,19 +158,19 @@ 
         $ret['sum'] = isset($sum) ? $sum : 0;
         return $ret;
 	}
-	function already_rated($item, $itemid, $dirname, $uid){
+	function already_rated($item, $itemid, $dirname, $uid) {
 
 		$criteria = new CriteriaCompo();
-		$criteria->add(new Criteria('item',$item ));
-		$criteria->add(new Criteria('itemid',$itemid ));
+		$criteria->add(new Criteria('item', $item));
+		$criteria->add(new Criteria('itemid', $itemid));
 		$criteria->add(new Criteria('dirname', $dirname));
 		$criteria->add(new Criteria('user.uid', $uid));
 
 		$ret = $this->getObjects($criteria);
 
-		if(!$ret){
+		if (!$ret) {
 			return false;
-		}else{
+		} else {
 			return $ret[0];
 		}
 

class/smartdbupdater.php

Doc Comments +8 added lines, -1 removed lines

@@ -129,6 +129,10 @@ 
         }
         return $fields;
     }
+
+    /**
+     * @param string $field
+     */
     function fieldExists($field) {
         $existingFields = $this->getExistingFieldsArray();
         return isset ($existingFields[$field]);
@@ -541,7 +545,7 @@ 
     /**
      * Use to update a table
      *
-     * @param object $table {@link SmartDbTable} that will be updated
+     * @param SmartDbTable $table {@link SmartDbTable} that will be updated
      *
      * @see SmartDbTable
      *
@@ -601,6 +605,9 @@ 
         return $ret;
     }
 
+    /**
+     * @return string
+     */
     function getFieldDefaultFromVar($var, $key = false) {
         if ($var['value']) {
             return $var['value'];

Spacing +18 added lines, -18 removed lines

@@ -77,7 +77,7 @@ 
      */ //felix
     var $_updatedWhere;
 
-    var $_existingFieldsArray=false;
+    var $_existingFieldsArray = false;
 
     /**
      * Constructor
@@ -87,7 +87,7 @@ 
      */
     function SmartDbTable($name) {
         $this->_name = $name;
-        $this->_data = array ();
+        $this->_data = array();
     }
 
     /**
@@ -207,7 +207,7 @@ 
      * @param string $properties properties of the field
      *
      */
-    function addAlteredField($name, $properties, $newname=false, $showerror = true) {
+    function addAlteredField($name, $properties, $newname = false, $showerror = true) {
         $field['name'] = $name;
         $field['properties'] = $properties;
         $field['showerror'] = $showerror;
@@ -326,7 +326,7 @@ 
         //xoops_debug($query);
         $ret = $xoopsDB->query($query);
         if (!$ret) {
-            echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+            echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CREATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error() . ")<br />";
 
         } else {
             echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CREATE_TABLE, $this->name()) . "<br />";
@@ -344,7 +344,7 @@ 
         $query = sprintf("DROP TABLE %s", $this->name());
         $ret = $xoopsDB->query($query);
         if (!$ret) {
-            echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+            echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROP_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error() . ")<br />";
             return false;
         } else {
             echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROP_TABLE, $this->name()) . "<br />";
@@ -370,7 +370,7 @@ 
             $ret = $ret && $xoopsDB->query($query);
             if ($alteredField['showerror']) {
                 if (!$ret) {
-                    echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+                    echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CHGFIELD_ERR, $alteredField['name'], $this->name()) . " (" . $xoopsDB->error() . ")<br />";
                 } else {
                     echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_CHGFIELD, $alteredField['name'], $this->name()) . "<br />";
                 }
@@ -413,7 +413,7 @@ 
             $query = sprintf("UPDATE %s SET %s = %s", $this->name(), $updatedField['name'], $updatedField['value']);
             $ret = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error() . ")<br />";
             } else {
                 echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . "<br />";
             }
@@ -434,7 +434,7 @@ 
             //echo $query."<br>";
             $ret = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE_ERR, $this->name()) . " (" . $xoopsDB->error() . ")<br />";
             } else {
                 echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_UPDATE_TABLE, $this->name()) . "<br />";
             }
@@ -454,7 +454,7 @@ 
             $query = sprintf("ALTER TABLE %s DROP %s", $this->name(), $dropedField);
             $ret = $ret && $xoopsDB->query($query);
             if (!$ret) {
-                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROPFIELD_ERR, $dropedField, $this->name()) . " (" . $xoopsDB->error(). ")<br />";
+                echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROPFIELD_ERR, $dropedField, $this->name()) . " (" . $xoopsDB->error() . ")<br />";
             } else {
                 echo "&nbsp;&nbsp;" . sprintf(_SDU_MSG_DROPFIELD, $dropedField, $this->name()) . "<br />";
             }
@@ -588,7 +588,7 @@ 
 
     function automaticUpgrade($module, $item) {
         if (is_array($item)) {
-            foreach($item as $v) {
+            foreach ($item as $v) {
                 $this->upgradeObjectItem($module, $v);
             }
         } else {
@@ -634,13 +634,13 @@ 
         if (!$table->exists()) {
             // table was never created, let's do it
             $structure = "";
-            foreach($objectVars as $key=>$var) {
+            foreach ($objectVars as $key=>$var) {
                 if ($var['persistent']) {
                     $type = $this->getFieldTypeFromVar($var);
                     if ($key == $module_handler->keyName) {
                         $extra = "auto_increment";
                     } else {
-                        $default =  $this->getFieldDefaultFromVar($var);
+                        $default = $this->getFieldDefaultFromVar($var);
                         $extra = "default '$default'
 ";
                     }
@@ -658,21 +658,21 @@ 
             }
         } else {
             $existingFieldsArray = $table->getExistingFieldsArray();
-            foreach($objectVars as $key=>$var) {
+            foreach ($objectVars as $key=>$var) {
                 if ($var['persistent']) {
                     if (!isset($existingFieldsArray[$key])) {
                         // the fiels does not exist, let's create it
                         $type = $this->getFieldTypeFromVar($var);
-                        $default =  $this->getFieldDefaultFromVar($var);
+                        $default = $this->getFieldDefaultFromVar($var);
                         $table->addNewField($key, "$type not null default '$default'");
                     } else {
                         // if field already exists, let's check if the definition is correct
-                        $definition =  strtolower($existingFieldsArray[$key]);
+                        $definition = strtolower($existingFieldsArray[$key]);
                         $type = $this->getFieldTypeFromVar($var);
                         if ($key == $module_handler->keyName) {
                             $extra = "auto_increment";
                         } else {
-                            $default =  $this->getFieldDefaultFromVar($var, $key);
+                            $default = $this->getFieldDefaultFromVar($var, $key);
                             $extra = "default '$default'";
                         }
                         $actual_definition = "$type not null $extra";
@@ -716,7 +716,7 @@ 
             }
         }
 
-        $dbVersion  = smart_GetMeta('version', $dirname);
+        $dbVersion = smart_GetMeta('version', $dirname);
         if (!$dbVersion) {
             $dbVersion = 0;
         }
@@ -725,7 +725,7 @@ 
         echo 'New database version : ' . $newDbVersion . '<br />';
 
         if ($newDbVersion > $dbVersion) {
-            for($i=$dbVersion+1;$i<=$newDbVersion; $i++) {
+            for ($i = $dbVersion + 1; $i <= $newDbVersion; $i++) {
                 $upgrade_function = $dirname . '_db_upgrade_' . $i;
                 if (function_exists($upgrade_function)) {
                     $upgrade_function();

class/smartexport.php

Doc Comments +7 added lines

@@ -177,6 +177,10 @@ 
 		return implode($separator, $ret);
 
 	}
+
+	/**
+	 * @param false|string $trimFunction
+	 */
 	function valToCsvHelper($val, $separator, $trimFunction) {
 		if ($trimFunction)
 			$val = $trimFunction ($val);
@@ -221,6 +225,9 @@ 
 		$this->saveExportFile($exportFileData);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	function saveExportFile($content) {
 		switch ($this->format) {
 			case 'csv':

Spacing +19 added lines, -19 removed lines

@@ -27,7 +27,7 @@ 
 	var $filename;
 	var $filepath;
 	var	$options;
-	var $outputMethods=false;
+	var $outputMethods = false;
 	var $notDisplayFields;
 
 	/**
@@ -41,7 +41,7 @@ 
 	 * @param string $format format of the ouputed export. Currently only supports CSV
 	 * @param array $options options of the format to be exported in
 	 */
-	function SmartObjectExport(&$objectHandler, $criteria=null, $fields=false, $filename=false, $filepath=false, $format='csv', $options=false) {
+	function SmartObjectExport(&$objectHandler, $criteria = null, $fields = false, $filename = false, $filepath = false, $format = 'csv', $options = false) {
 		$this->handler = $objectHandler;
 		$this->criteria = $criteria;
 		$this->fields = $fields;
@@ -101,17 +101,17 @@ 
 	/*
 	 * Set an array of fields that we don't want in export
 	 */
-	 function setNotDisplayFields($fields){
-	 	if(!$this->notDisplayFields){
-	 		if(is_array($fields)){
+	 function setNotDisplayFields($fields) {
+	 	if (!$this->notDisplayFields) {
+	 		if (is_array($fields)) {
 	 			$this->notDisplayFields = $fields;
-	 		}else{
+	 		} else {
 	 			$this->notDisplayFields = array($fields);
 	 		}
-	 	}else{
-	 		if(is_array($fields)){
+	 	} else {
+	 		if (is_array($fields)) {
 	 			$this->notDisplayFields = array_merge($this->notDisplayFields, $fields);
-	 		}else{
+	 		} else {
 	 			$this->notDisplayFields[] = $fields;
 	 		}
 	 	}
@@ -144,7 +144,7 @@ 
 	 * @param string $filepath path where the file will be saved
 	 * @param array $options options of the format to be exported in
 	 */
-	function SmartExportRenderer($data, $filename=false, $filepath=false, $format='csv', $options=array('separator'=>';')) {
+	function SmartExportRenderer($data, $filename = false, $filepath = false, $format = 'csv', $options = array('separator'=>';')) {
 		$this->data = $data;
 		$this->format = $format;
 		$this->filename = $filename;
@@ -169,8 +169,8 @@ 
 				$trimFunction = 'trim';
 				break;
 		}
-		$ret = array ();
-		foreach($dataArray as $key=>$field){
+		$ret = array();
+		foreach ($dataArray as $key=>$field) {
 			$ret[$key] = $this->valToCsvHelper($field, $separator, $trimFunction);
 		}
 
@@ -179,7 +179,7 @@ 
 	}
 	function valToCsvHelper($val, $separator, $trimFunction) {
 		if ($trimFunction)
-			$val = $trimFunction ($val);
+			$val = $trimFunction($val);
 		//If there is a separator (;) or a quote (") or a linebreak in the string, we need to quote it.
 		$needQuote = FALSE;
 		do {
@@ -213,7 +213,7 @@ 
 				$firstRow = implode($separator, $this->data['columnsHeaders']);
 				$exportFileData .= $firstRow . "\r\n";
 
-				foreach($this->data['rows'] as $cols) {
+				foreach ($this->data['rows'] as $cols) {
 					$exportFileData .= $this->arrayToCsvString($cols, $separator) . "\r\n";
 				}
 			break;
@@ -247,7 +247,7 @@ 
 		} else {
 			$mimeType = 'text/csv';
 		    $file = strrev($this->filename);
-		    $temp_name = strtolower(strrev(substr($file,0,strpos($file,"--"))) );
+		    $temp_name = strtolower(strrev(substr($file, 0, strpos($file, "--"))));
 			if ($temp_name == '') {
 				$file_name = $this->filename;
 			} else {
@@ -255,21 +255,21 @@ 
 			}
 		    $fullFileName = $this->filepath . stripslashes(trim($this->filename));
 
-		    if(ini_get('zlib.output_compression')) {
+		    if (ini_get('zlib.output_compression')) {
 		        ini_set('zlib.output_compression', 'Off');
 		    }
 
 		    header("Pragma: public");
 		    header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
-		    header("Cache-Control: private",false);
+		    header("Cache-Control: private", false);
 		    header("Content-Transfer-Encoding: binary");
-		    if(isset($mimeType)) {
+		    if (isset($mimeType)) {
 		        header("Content-Type: " . $mimeType);
 		    }
 
 		    header("Content-Disposition: attachment; filename=" . $file_name);
 
-		    if(isset($mimeType) && strstr($mimeType, "text/")) {
+		    if (isset($mimeType) && strstr($mimeType, "text/")) {
 		        $fp = fopen($fullFileName, "r");
 		    }
 		    else {