SonglistFormSelectSong

Complexity

Total Complexity

38

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptions()	0	10	5
A	setValue()	0	8	4
A	getValue()	0	10	4
A	getSize()	0	3	1
A	render()	0	21	5
A	renderValidationJS()	0	14	4
A	addOptionArray()	0	5	3
A	isMultiple()	0	3	1
A	addOption()	0	6	2
B	SonglistFormSelectSong()	0	37	9

<?php

/*
Module: Xcenter

Version: 2.01

Description: Multilingual Content Module with tags and lists with search functions

Author: Written by Simon Roberts aka. Wishcraft (simon@chronolabs.coop)

Owner: Chronolabs

License: See /docs - GPL 2.0
*/

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

/**
 *  Xoops Form Class Elements
 *
 * @copyright       The XOOPS Project http://sourceforge.net/projects/xoops/
 * @license         http://www.fsf.org/copyleft/gpl.html GNU public license
 * @package         class
 * @package         kernel
 * @subpackage      form
 * @author          Kazumi Ono <onokazu@xoops.org>
 * @author          Taiwen Jiang <phppp@users.sourceforge.net>
 * @author          John Neill <catzwolf@xoops.org>
 * @version         $Id: formselect.php 3988 2009-12-05 15:46:47Z trabis $
 */
defined('XOOPS_ROOT_PATH') or die('Restricted access');

xoops_load('XoopsFormElement');

/**
 * A select field
 *
 * @author 		Kazumi Ono <onokazu@xoops.org>
 * @author 		Taiwen Jiang <phppp@users.sourceforge.net>
 * @author 		John Neill <catzwolf@xoops.org>
 * @copyright   The XOOPS Project http://sourceforge.net/projects/xoops/
 * @package 	kernel
 * @subpackage 	form
 * @access 		public
 */
class SonglistFormSelectSong extends XoopsFormElement
{
    /**
     * Options
     *
     * @var array
     * @access private
     */
    var $_options = array();

    /**
     * Allow multiple selections?
     *
     * @var bool
     * @access private
     */
    var $_multiple = false;

    /**
     * Number of rows. "1" makes a dropdown list.
     *
     * @var int
     * @access private
     */
    var $_size;

    /**
     * Pre-selcted values
     *
     * @var array
     * @access private
     */
    var $_value = array();

    /**
     * Constructor
     *
     * @param string $caption Caption
     * @param string $name "name" attribute
     * @param mixed $value Pre-selected value (or array of them).
     * @param int $size Number or rows. "1" makes a drop-down-list
     * @param bool $multiple Allow multiple selections?
     */
    function SonglistFormSelectSong($caption, $name, $value = null, $size = 1, $multiple = false, $id=-1, $field = 'cid')

It is generally recommended to explicitly declare the visibility for methods.

    {
    	global $_form_object_options;
    	xoops_loadLanguage('modinfo', 'songlist');
    	
        $this->setCaption($caption);
        $this->setName($name);
        $this->_multiple = $multiple;
        $this->_size = intval($size);
        if (isset($value)) {
            $this->setValue($value);
        }
		$this->addOption('0', _MI_SONGLIST_NONE);
		if ($id==-1) {
			if (!isset($_form_object_options['songs'][$field][$id])) {
				$songs_handler =& xoops_getmodulehandler('songs', 'songlist');
				$criteria = new Criteria('1', '1');
				$criteria->setSort('`title`');
				$criteria->setOrder('ASC');
				foreach($songs_handler->getObjects($criteria, true) as $id => $obj) { 

The method getObjects() does not exist on XoopsObjectHandler. It seems like you code against a sub-type of said class. However, the method does not exist in XoopsRankHandler or XoUserHandler. Are you sure you never get one of those?

					$_form_object_options['songs'][$field][$id][$id] = $obj->getVar('title');
				}
			}
		} else {
			if (!isset($_form_object_options['songs'][$field][$id])) {
				$songs_handler =& xoops_getmodulehandler('songs', 'songlist');
				$criteria = new Criteria('`'.$field.'`', $id);
				$criteria->setSort('`title`');
				$criteria->setOrder('ASC');
				foreach($songs_handler->getObjects($criteria) as $id => $obj) { 
					$_form_object_options['songs'][$field][$id][$id] = $obj->getVar('title');
				}
			}
		}
		if (isset($_form_object_options['songs'][$field][$id]))
			foreach($_form_object_options['songs'][$field][$id] as $id => $value)
				$this->addOption($id, $value);
    }

    /**
     * Are multiple selections allowed?
     *
     * @return bool
     */
    function isMultiple()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->_multiple;
    }

    /**
     * Get the size
     *
     * @return int
     */
    function getSize()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->_size;
    }

    /**
     * Get an array of pre-selected values
     *
     * @param bool $encode To sanitizer the text?
     * @return array
     */
    function getValue($encode = false)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if (! $encode) {
            return $this->_value;
        }
        $value = array();
        foreach($this->_value as $val) {
            $value[] = $val ? htmlspecialchars($val, ENT_QUOTES) : $val;
        }
        return $value;
    }

    /**
     * Set pre-selected values
     *
     * @param  $value mixed
     */
    function setValue($value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if (is_array($value)) {
            foreach($value as $v) {
                $this->_value[] = $v;
            }
        } elseif (isset($value)) {
            $this->_value[] = $value;
        }
    }

    /**
     * Add an option
     *
     * @param string $value "value" attribute
     * @param string $name "name" attribute
     */
    function addOption($value, $name = '')

It is generally recommended to explicitly declare the visibility for methods.

    {
        if ($name != '') {
            $this->_options[$value] = $name;
        } else {
            $this->_options[$value] = $value;
        }
    }

    /**
     * Add multiple options
     *
     * @param array $options Associative array of value->name pairs
     */
    function addOptionArray($options)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if (is_array($options)) {

The condition is_array($options) is always true.

            foreach($options as $k => $v) {
                $this->addOption($k, $v);
            }
        }
    }

    /**
     * Get an array with all the options
     *
     * Note: both name and value should be sanitized. However for backward compatibility, only value is sanitized for now.
     *
     * @param int $encode To sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name
     * @return array Associative array of value->name pairs
     */
    function getOptions($encode = false)

It is generally recommended to explicitly declare the visibility for methods.

    {
        if (! $encode) {

The expression $encode of type false|integer is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === false instead.

            return $this->_options;
        }
        $value = array();
        foreach($this->_options as $val => $name) {
            $value[$encode ? htmlspecialchars($val, ENT_QUOTES) : $val] = ($encode > 1) ? htmlspecialchars($name, ENT_QUOTES) : $name;
        }
        return $value;
    }

    /**
     * Prepare HTML for output
     *
     * @return string HTML
     */
    function render()

It is generally recommended to explicitly declare the visibility for methods.

    {
        $ele_name = $this->getName();
		$ele_title = $this->getTitle();
        $ele_value = $this->getValue();
        $ele_options = $this->getOptions();
        $ret = '<select size="'.$this->getSize().'"'.$this->getExtra();
        if ($this->isMultiple() != false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison !== instead.

            $ret .= ' name="'.$ele_name.'[]" id="'.$ele_name.'" title="'. $ele_title. '" multiple="multiple">' ;
        } else {
            $ret .= ' name="'.$ele_name.'" id="'.$ele_name.'" title="'. $ele_title. '">' ;
        }
        foreach($ele_options as $value => $name) {
            $ret .= '<option value="'.htmlspecialchars($value, ENT_QUOTES).'"';
            if (count($ele_value) > 0 && in_array($value, $ele_value)) {
                $ret .= ' selected="selected"';
            }
            $ret .= '>'.$name.'</option>' ;
        }
        $ret .= '</select>';
        return $ret;
    }

    /**
     * Render custom javascript validation code
     *
     * @seealso XoopsForm::renderValidationJS
     */
    function renderValidationJS()

It is generally recommended to explicitly declare the visibility for methods.

    {
        // render custom validation code if any
        if (! empty($this->customValidationCode)) {
            return implode("\n", $this->customValidationCode);
            // generate validation code if required
        } elseif ($this->isRequired()) {
            $eltname = $this->getName();
            $eltcaption = $this->getCaption();
            $eltmsg = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
            $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
            return "\nvar hasSelected = false; var selectBox = myform.{$eltname};"."for (i = 0; i < selectBox.options.length; i++ ) { if (selectBox.options[i].selected == true) { hasSelected = true; break; } }"."if (!hasSelected) { window.alert(\"{$eltmsg}\"); selectBox.focus(); return false; }";
        }
        return '';
    }
}

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.