MakeTable::setActionFieldName() - Code Metrics - Inspection of "Refactoring" - evolution-cms/evolution - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — develop (#716)

by Agel_Nash
created 2018-06-07 21:32 UTC
MakeTable::setActionFieldName() A

↳ Parent: MakeTable
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
<?php namespace EvolutionCMS\Support;

use EvolutionCMS\Interfaces\MakeTableInterface;

/**
 * A utility class for presenting a provided array as a table view.  Includes
 * support for pagination, sorting by any column, providing optional header arrays,
 * providing classes for styling the table, rows, and cells (including alternate
 * row styling), as well as adding form controls to each row.
 *
 * @author Jason Coward <[email protected]> (MODX)
 */
class MakeTable implements MakeTableInterface
{
    /**
     * @var string
     */
    public $actionField = '';
    /**
     * @var string
     */
    public $cellAction = '';
    /**
     * @var string
     */
    public $linkAction = '';
    /**
     * @var int
     */
    public $tableWidth = 0;
    /**
     * @var string
     */
    public $tableClass = '';
    /**
     * @var
     */
    public $tableID;
    /**
     * @var
     */
    public $thClass;
    /**
     * @var string
     */
    public $rowHeaderClass = '';
    /**
     * @var string
     */
    public $columnHeaderClass = '';
    /**
     * @var string
     */
    public $rowRegularClass = '';
    /**
     * @var string
     */
    public $rowAlternateClass = 'alt';
    /**
     * @var string
     */
    public $formName = 'tableForm';
    /**
     * @var string
     */
    public $formAction = '[~[*id*]~]';
    /**
     * @var string
     */
    public $formElementType = '';
    /**
     * @var string
     */
    public $formElementName = '';
    /**
     * @var string
     */
    public $rowAlternatingScheme = 'EVEN';
    /**
     * @var array
     */
    public $excludeFields = array();
    /**
     * @var int
     */
    public $allOption = 0;
    /**
     * @var
     */
    public $pageNav;
    /**
     * @var array
     */
    public $columnWidths = array();
    /**
     * @var array
     */
    public $selectedValues = array();
    /**
     * @var array
     */
    public $fieldHeaders = array();
    /**
     * @var string
     */
    public $extra = '';

    /**
     * Sets the default link href for all cells in the table.
     *
     * @param string $value A URL to execute when table cells are clicked.
     */
    public function setCellAction($value)
    {
        $this->cellAction = $this->prepareLink($value);
    }

    /**
     * Sets the default link href for the text presented in a cell.
     *
     * @param string $value A URL to execute when text within table cells are clicked.
     */
    public function setLinkAction($value)
    {
        $this->linkAction = $this->prepareLink($value);
    }

    /**
     * Sets the width attribute of the main HTML TABLE.
     *
     * @param int $value A valid width attribute for the HTML TABLE tag
     */
    public function setTableWidth($value)
    {
        $this->tableWidth = (int)$value;
    }

    /**
     * Sets the class attribute of the main HTML TABLE.
     *
     * @param string $value A class for the main HTML TABLE.
     */
    public function setTableClass($value)
    {
        $this->tableClass = $value;
    }

    /**
     * Sets the id attribute of the main HTML TABLE.
     *
     * @param string $value A class for the main HTML TABLE.
     */
    public function setTableID($value)
    {
        $this->tableID = $value;
    }

    /**
     * Sets the class attribute of the table header row.
     *
     * @param string $value A class for the table header row.
     */
    public function setRowHeaderClass($value)
    {
        $this->rowHeaderClass = $value;
    }

    /**
     * Sets the class attribute of the table header row.
     *
     * @param string $value A class for the table header row.
     */
    public function setThHeaderClass($value)
    {
        $this->thClass = $value;
    }

    /**
     * Sets the class attribute of the column header row.
     *
     * @param string $value A class for the column header row.
     */
    public function setColumnHeaderClass($value)
    {
        $this->columnHeaderClass = $value;
    }

    /**
     * Sets the class attribute of regular table rows.
     *
     * @param string $value A class for regular table rows.
     */
    public function setRowRegularClass($value)
    {
        $this->rowRegularClass = $value;
    }

    /**
     * Sets the class attribute of alternate table rows.
     *
     * @param string $value A class for alternate table rows.
     */
    public function setRowAlternateClass($value)
    {
        $this->rowAlternateClass = $value;
    }

    /**
     * Sets the type of INPUT form element to be presented as the first column.
     *
     * @param string $value Indicates the INPUT form element type attribute.
     */
    public function setFormElementType($value)
    {
        $this->formElementType = $value;
    }

    /**
     * Sets the name of the INPUT form element to be presented as the first column.
     *
     * @param string $value Indicates the INPUT form element name attribute.
     */
    public function setFormElementName($value)
    {
        $this->formElementName = $value;
    }

    /**
     * Sets the name of the FORM to wrap the table in when a form element has
     * been indicated.
     *
     * @param string $value Indicates the FORM name attribute.
     */
    public function setFormName($value)
    {
        $this->formName = $value;
    }

    /**
     * Sets the action of the FORM element.
     *
     * @param string $value Indicates the FORM action attribute.
     */
    public function setFormAction($value)
    {
        $this->formAction = $value;
    }

    /**
     * Excludes fields from the table by array key.
     *
     * @param array $value An Array of field keys to exclude from the table.
     */
    public function setExcludeFields($value)
    {
        $this->excludeFields = $value;
    }

    /**
     * Sets the table to provide alternate row colors using ODD or EVEN rows
     *
     * @param string $value 'ODD' or 'EVEN' to indicate the alternate row scheme.
     */
    public function setRowAlternatingScheme($value)
    {
        $this->rowAlternatingScheme = $value;
    }

    /**
     * Sets the default field value to be used when appending query parameters
     * to link actions.
     *
     * @param string $value The key of the field to add as a query string parameter.
     */
    public function setActionFieldName($value)
    {
        $this->actionField = $value;
    }

    /**
     * Sets the width attribute of each column in the array.
     *
     * @param array $value An Array of column widths in the order of the keys in the
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *            source table array.
     */
    public function setColumnWidths($widthArray)
    {
        $this->columnWidths = $widthArray;
    }

    /**
     * An optional array of values that can be preselected when using
     *
     * @param array $value Indicates the INPUT form element type attribute.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function setSelectedValues($valueArray)
    {
        $this->selectedValues = $valueArray;
    }

    /**
     * Sets extra content to be presented following the table (but within
     * the form, if a form is being rendered with the table).
     *
     * @param string $value A string of additional content.
     */
    public function setExtra($value)
    {
        $this->extra = $value;
    }

    /**
     * Retrieves the width of a specific table column by index position.
     *
     * @param int $columnPosition The index of the column to get the width for.
     * @return string
     */
    public function getColumnWidth($columnPosition)
    {
        $currentWidth = '';
        if (is_array($this->columnWidths)) {
            $currentWidth = $this->columnWidths[$columnPosition] ? ' width="' . $this->columnWidths[$columnPosition] . '" ' : '';
        }

        return $currentWidth;
    }

    /**
     * Determines what class the current row should have applied.
     *
     * @param int $value The position of the current row being rendered.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function determineRowClass($position)
    {
        switch ($this->rowAlternatingScheme) {
            case 'ODD' :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
                $modRemainder = 1;
                break;
            case 'EVEN' :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            default:
                $modRemainder = 0;
                break;
        }
        if ($position % 2 == $modRemainder) {
            $currentClass = $this->rowRegularClass;
        } else {
            $currentClass = $this->rowAlternateClass;
        }

        return ' class="' . $currentClass . '"';
    }

    /**
     * Generates an onclick action applied to the current cell, to execute
     * any specified cell actions.
     *
     * @param string $value Indicates the INPUT form element type attribute.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function getCellAction($currentActionFieldValue)

    {
        $cellAction = '';
        if ($this->cellAction) {
            $cellAction = ' onClick="javascript:window.location=\'' . $this->cellAction . $this->actionField . '=' . urlencode($currentActionFieldValue) . '\'" ';
        }

        return $cellAction;
    }

    /**
     * Generates the cell content, including any specified action fields values.
     *
     * @param string $currentActionFieldValue The value to be applied to the link action.
     * @param string $value The value of the cell.
     * @return string
     */
    public function createCellText($currentActionFieldValue, $value)

    {
        $cell = $value;
        if ($this->linkAction) {
            $cell = '<a href="' . $this->linkAction . $this->actionField . '=' . urlencode($currentActionFieldValue) . '">' . $cell . '</a>';
        }

        return $cell;
    }

    /**
     * Sets an option to generate a check all link when checkbox is indicated
     * as the table formElementType.
     */
    public function setAllOption()
    {
        $this->allOption = 1;
    }

    /**
     * Function to prepare a link generated in the table cell/link actions.
     *
     * @param string $value Indicates the INPUT form element type attribute.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function prepareLink($link)
    {
        if (strstr($link, '?')) {
            $end = '&';
        } else {
            $end = '?';
        }

        return $link . $end;
    }

    /**
     * Generates the table content.
     *
     * @param array $fieldsArray The associative array representing the table rows
     * and columns.
     * @param array $fieldHeadersArray An optional array of values for providing
     * alternative field headers; this is an associative arrays of keys from
     * the $fieldsArray where the values represent the alt heading content
     * for each column.
     * @return string
     */
    public function create($fieldsArray, $fieldHeadersArray = array(), $linkpage = "")

    {
        global $_lang;
        if (is_array($fieldsArray)) {
            $i = 0;
            foreach ($fieldsArray as $fieldName => $fieldValue) {
                $table .= "\t<tr" . $this->determineRowClass($i) . ">\n";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $currentActionFieldValue = $fieldValue[$this->actionField];
                if (is_array($this->selectedValues)) {
                    $isChecked = array_search($currentActionFieldValue, $this->selectedValues) === false ? 0 : 1;
                } else {
                    $isChecked = false;
                }
                $table .= $this->addFormField($currentActionFieldValue, $isChecked);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                $colPosition = 0;
                foreach ($fieldValue as $key => $value) {
                    if (!in_array($key, $this->excludeFields)) {
                        $table .= "\t\t<td" . $this->getCellAction($currentActionFieldValue) . ">";
                        $table .= $this->createCellText($currentActionFieldValue, $value);
                        $table .= "</td>\n";
                        if ($i == 0) {
                            if (empty ($header) && $this->formElementType) {
                                $header .= "\t\t<th style=\"width:32px\" " . ($this->thClass ? 'class="' . $this->thClass . '"' : '') . ">" . ($this->allOption ? '<a href="javascript:clickAll()">all</a>' : '') . "</th>\n";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                            }
                            $headerText = array_key_exists($key, $fieldHeadersArray) ? $fieldHeadersArray[$key] : $key;
                            $header .= "\t\t<th" . $this->getColumnWidth($colPosition) . ($this->thClass ? ' class="' . $this->thClass . '" ' : '') . ">" . $headerText . "</th>\n";
                        }
                        $colPosition++;
                    }
                }
                $i++;
                $table .= "\t</tr>\n";
            }
            $table = "\n" . '<table' . ($this->tableWidth > 0 ? ' width="' . $this->tableWidth . '"' : '') . ($this->tableClass ? ' class="' . $this->tableClass . '"' : '') . ($this->tableID ? ' id="' . $this->tableID . '"' : '') . ">\n" . ($header ? "\t<thead>\n\t<tr class=\"" . $this->rowHeaderClass . "\">\n" . $header . "\t</tr>\n\t</thead>\n" : '') . $table . "</table>\n";
            if ($this->formElementType) {
                $table = "\n" . '<form id="' . $this->formName . '" name="' . $this->formName . '" action="' . $this->formAction . '" method="POST">' . $table;
            }
            if (strlen($this->pageNav) > 1) {//changed to display the pagination if exists.
                /* commented this part because of cookie

                $table .= '<div id="max-display-records" ><select style="display:inline" onchange="javascript:updatePageSize(this[this.selectedIndex].value);">';
                $pageSizes= array (10, 25, 50, 100, 250);
                for ($i= 0; $i < count($pageSizes); $i ++) {
                    $table .= '<option value="'.$pageSizes[$i].'"';
                    $table .= MAX_DISPLAY_RECORDS_NUM == $pageSizes[$i] ? ' selected ' : '';
                    $table .= '>'.$pageSizes[$i].'</option>';
                }

                $table .= '</select>'.$_lang["pagination_table_perpage"].'</div>';
                */
                $table .= '<div id="pagination" class="paginate">' . $_lang["pagination_table_gotopage"] . '<ul>' . $this->pageNav . '</ul></div>';
                //$table .= '<script language="javascript">function updatePageSize(size){window.location = \''.$this->prepareLink($linkpage).'pageSize=\'+size;}</script>';


            }
            if ($this->allOption) {
                $table .= '
<script language="javascript">
	toggled = 0;
	function clickAll() {
		myform = document.getElementById("' . $this->formName . '");
		for(i=0;i<myform.length;i++) {
			if(myform.elements[i].type==\'checkbox\') {
				myform.elements[i].checked=(toggled?false:true);
			}
		}
		toggled = (toggled?0:1);
	}
</script>';
            }
            if ($this->formElementType) {
                if ($this->extra) {
                    $table .= "\n" . $this->extra . "\n";
                }
                $table .= "\n" . '</form>' . "\n";
            }

            return $table;
        }

        return '';
    }

    /**
     * Generates optional paging navigation controls for the table.
     *
     * @param int $numRecords The number of records to show per page.
     * @param string $qs An optional query string to be appended to the paging links
     * @return void
     */
    public function createPagingNavigation($numRecords, $qs = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        global $_lang;
        $currentPage = (is_numeric($_GET['page']) ? $_GET['page'] : 1);
        $numPages = ceil($numRecords / MAX_DISPLAY_RECORDS_NUM);
        $nav = '';
        if ($numPages > 1) {
            $currentURL = empty($qs) ? '' : '?' . $qs;
            if ($currentPage > 6) {
                $nav .= $this->createPageLink($currentURL, 1, $_lang["pagination_table_first"]);
            }
            if ($currentPage != 1) {
                $nav .= $this->createPageLink($currentURL, $currentPage - 1, '&lt;&lt;');
            }
            $offset = -4 + ($currentPage < 5 ? (5 - $currentPage) : 0);
            $i = 1;
            while ($i < 10 && ($currentPage + $offset <= $numPages)) {
                if ($currentPage == $currentPage + $offset) {
                    $nav .= $this->createPageLink($currentURL, $currentPage + $offset, $currentPage + $offset, true);
                } else {
                    $nav .= $this->createPageLink($currentURL, $currentPage + $offset, $currentPage + $offset);
                }
                $i++;
                $offset++;
            }
            if ($currentPage < $numPages) {
                $nav .= $this->createPageLink($currentURL, $currentPage + 1, '&gt;&gt;');
            }
            if ($currentPage != $numPages) {
                $nav .= $this->createPageLink($currentURL, $numPages, $_lang["pagination_table_last"]);
            }
        }
        $this->pageNav = ' ' . $nav;
    }

    /**
     * Creates an individual page link for the paging navigation.
     *
     * @param string $link The link for the page, defaulted to the current document.
     * @param int $pageNum The page number of the link.
     * @param string $displayText The text of the link.
     * @param bool $currentPage Indicates if the link is to the current page.
     * @param string $qs And optional query string to be appended to the link.
     * @return string
     */
    public function createPageLink($link = '', $pageNum, $displayText, $currentPage = false, $qs = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $modx = evolutionCMS();
        $orderBy = !empty($_GET['orderby']) ? '&orderby=' . $_GET['orderby'] : '';
        $orderDir = !empty($_GET['orderdir']) ? '&orderdir=' . $_GET['orderdir'] : '';
        if (!empty($qs)) {
            $qs = "?$qs";
        }
        $link = empty($link) ? $modx->makeUrl($modx->documentIdentifier, $modx->documentObject['alias'],
            $qs . "page=$pageNum$orderBy$orderDir") : $this->prepareLink($link) . "page=$pageNum";
        $nav = '<li' . ($currentPage ? ' class="currentPage"' : '') . '><a' . ($currentPage ? ' class="currentPage"' : '') . ' href="' . $link . '">' . $displayText . '</a></li>' . "\n";

        return $nav;
    }

    /**
     * Adds an INPUT form element column to the table.
     *
     * @param string $value The value attribute of the element.
     * @param bool $isChecked Indicates if the checked attribute should apply to the
     * element.
     * @return string
     */
    public function addFormField($value, $isChecked)
    {
        $field = '';
        if ($this->formElementType) {
            $checked = $isChecked ? "checked " : "";
            $field = "\t\t" . '<td><input type="' . $this->formElementType . '" name="' . ($this->formElementName ? $this->formElementName : $value) . '"  value="' . $value . '" ' . $checked . '/></td>' . "\n";
        }

        return $field;
    }

    /**
     * Generates the proper LIMIT clause for queries to retrieve paged results in
     * a MakeTable $fieldsArray.
     * @return string
     */
    public function handlePaging()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $offset = (is_numeric($_GET['page']) && $_GET['page'] > 0) ? $_GET['page'] - 1 : 0;
        $limitClause = ' LIMIT ' . ($offset * MAX_DISPLAY_RECORDS_NUM) . ', ' . MAX_DISPLAY_RECORDS_NUM;

        return $limitClause;
    }

    /**
     * Generates the SORT BY clause for queries used to retrieve a MakeTable
     * $fieldsArray
     *
     * @param bool $natural_order If true, the results are returned in natural order.
     * @return string
     */
    public function handleSorting($natural_order = false)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $orderByClause = '';
        if ((bool)$natural_order === false) {
            $orderby = !empty($_GET['orderby']) ? $_GET['orderby'] : "id";
            $orderdir = !empty($_GET['orderdir']) ? $_GET['orderdir'] : "DESC";
            $orderByClause = !empty($orderby) ? ' ORDER BY ' . $orderby . ' ' . $orderdir . ' ' : "";
        }

        return $orderByClause;
    }

    /**
     * Generates a link to order by a specific $fieldsArray key; use to generate
     * sort by links in the MakeTable $fieldHeadingsArray values.
     *
     * @param string $key The $fieldsArray key for the column to sort by.
     * @param string $text The text for the link (e.g. table column header).
     * @param string $qs An optional query string to append to the order by link.
     * @return string
     */
    public function prepareOrderByLink($key, $text, $qs = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $modx = evolutionCMS();
        if (!empty($_GET['orderdir'])) {
            $orderDir = strtolower($_GET['orderdir']) == 'desc' ? '&orderdir=asc' : '&orderdir=desc';
        } else {
            $orderDir = '&orderdir=asc';
        }
        if (!empty($qs)) {
            if (!strrpos($qs, '&') == strlen($qs) - 1) {
                $qs .= '&';
            }
        }

        return '<a href="[~' . $modx->documentIdentifier . '~]?' . $qs . 'orderby=' . $key . $orderDir . '">' . $text . '</a>';
    }

}

Pull Request — develop (#716)

MakeTable::setActionFieldName() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

evolution-cms / evolution

Pull Request — develop (#716)

MakeTable::setActionFieldName() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
