AlumniObjectTree::alumni_getAllChild() - Code Metrics - mambax7/alumni-26x - Measure and Improve Code Quality continuously with Scrutinizer

AlumniObjectTree::alumni_getAllChild() A
last analyzed 2017-12-19 09:37 UTC

↳ Parent: AlumniObjectTree

Complexity

Conditions	4
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	2
nop	2
dl	0
loc	14
rs	9.2
c	0
b	0
f	0

<?php

/*
 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 tree class
 *
 * @copyright   XOOPS Project https://xoops.org/
 * @license     GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 * @package     class
 * @since       2.0.0
 * @author      Kazumi Ono (http://www.myweb.ne.jp/, http://jp.xoops.org/)
 * @author      Edited by John Mordo (jlm69)
 * @version     $Id$
 */

defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');

/**
 * A tree structures with {@link XoopsObject}s as nodes
 *
 * @package    kernel
 * @subpackage core
 * @author     Kazumi Ono <[email protected]>
 */
class AlumniObjectTree extends XoopsObjectTree
namespace YourVendor;

class YourClass { }
{
    /**
     * @var string
     */
    private $_parentId;


    /**
     * @var string
     */
    private $_myId;


    /**
     * @var null|string
     */
    private $_rootId = null;


    /**
     * @var array
     */
    private $_tree = [];


    /**
     * @var array
     */
    private $_objects;


    /**
     * Constructor
     *
     * @param array  $objectArr Array of {@link XoopsObject}s
     * @param string $myId      field name of object ID
     * @param string $parentId  field name of parent object ID
     * @param string $rootId    field name of root object ID

     */
    public function __construct(&$objectArr, $myId, $parentId, $rootId = null)
    {
        $this->_objects  = $objectArr;
        $this->_myId     = $myId;
        $this->_parentId = $parentId;
        if (null !== $rootId) {
            $this->_rootId = $rootId;
        }
        $this->_initialize();
    }

    /**
     * Initialize the object
     *
     * @access private
     */
    private function _initialize()

    {
        /* @var $object XoopsObject */
        foreach ($this->_objects as $object) {
            $key1                          = $object->getVar($this->_myId);
            $this->_tree[$key1]['obj']     = $object;
            $key2                          = $object->getVar($this->_parentId);
            $this->_tree[$key1]['parent']  = $key2;
            $this->_tree[$key2]['child'][] = $key1;
            if (null !== $this->_rootId) {
                $this->_tree[$key1]['root'] = $object->getVar($this->_rootId);
            }
        }
    }

    /**
     * Get the tree
     *
     * @return array Associative array comprising the tree
     */
    public function alumni_getTree()

    {
        return $this->_tree;
    }

    /**
     * returns an object from the tree specified by its id
     *
     * @param  string $key ID of the object to retrieve
     * @return XoopsObject Object within the tree
     */
    public function alumni_getByKey($key)

    {
        return $this->_tree[$key]['obj'];
    }

    /**
     * returns an array of all the first child object of an object specified by its id
     *
     * @param  string $key ID of the parent object
     * @return array  Array of children of the parent
     */
    public function alumni_getFirstChild($key)

    {
        $ret = [];
        if (isset($this->_tree[$key]['child'])) {
            foreach ($this->_tree[$key]['child'] as $childkey) {
                $ret[$childkey] = $this->_tree[$childkey]['obj'];
            }
        }

        return $ret;
    }

    /**
     * returns an array of all child objects of an object specified by its id
     *
     * @param  string $key ID of the parent
     * @param  array  $ret (Empty when called from client) Array of children from previous recursions.
     * @return array  Array of child nodes.
     */
    public function alumni_getAllChild($key, $ret = [])

    {
        if (isset($this->_tree[$key]['child'])) {
            foreach ($this->_tree[$key]['child'] as $childkey) {
                $ret[$childkey] = $this->_tree[$childkey]['obj'];
                $children       = $this->alumni_getAllChild($childkey, $ret);
                foreach (array_keys($children) as $newkey) {
                    $ret[$newkey] = $children[$newkey];
                }
            }
        }

        return $ret;
    }

    /**
     * returns an array of all parent objects.
     * the key of returned array represents how many levels up from the specified object
     *
     * @param  string $key     ID of the child object
     * @param  array  $ret     (empty when called from outside) Result from previous recursions
     * @param  int    $uplevel (empty when called from outside) level of recursion
     * @return array  Array of parent nodes.
     */
    public function alumni_getAllParent($key, $ret = [], $uplevel = 1)

    {
        if (isset($this->_tree[$key]['parent']) && isset($this->_tree[$this->_tree[$key]['parent']]['obj'])) {
            $ret[$uplevel] = $this->_tree[$this->_tree[$key]['parent']]['obj'];
            $parents       = $this->alumni_getAllParent($this->_tree[$key]['parent'], $ret, $uplevel + 1);
            foreach (array_keys($parents) as $newkey) {
                $ret[$newkey] = $parents[$newkey];
            }
        }

        return $ret;
    }

    /**
     * Make options for a select box from
     *
     * @param string $fieldName   Name of the member variable from the
     *                            node objects that should be used as the title for the options.
     * @param string $selected    Value to display as selected
     * @param int    $key         ID of the object to display as the root of select options
     * @param string $ret         (reference to a string when called from outside) Result from previous recursions
     * @param string $prefix_orig String to indent items at deeper levels
     * @param string $prefix_curr String to indent the current item
     *
     * @return void
     */
    private function alumni_makeSelBoxOptions($fieldName, $selected, $key, &$ret, $prefix_orig, $prefix_curr = '')

    {
        if ($key > 0) {
            /* @var $object XoopsObject */
            $object = $this->_tree[$key]['obj'];
            $value  = $object->getVar($this->_myId);
            $ret    .= '<option value="' . $value . '"';
            if ($value == $selected) {
                $ret .= ' selected="selected"';
            }
            $ret         .= '>' . $prefix_curr . $object->getVar($fieldName) . '</option>';

            $prefix_curr .= $prefix_orig;

        }
        if (isset($this->_tree[$key]['child']) && !empty($this->_tree[$key]['child'])) {

            foreach ($this->_tree[$key]['child'] as $childkey) {
                $this->alumni_makeSelBoxOptions($fieldName, $selected, $childkey, $ret, $prefix_orig, $prefix_curr);

            }
        }
    }

    /**
     * Make a select box with options from the tree
     *
     * @param          $name
     * @param  string  $fieldName      Name of the member variable from the
     *                                 node objects that should be used as the title for the options.
     * @param  string  $prefix         String to indent deeper levels
     * @param  string  $selected       Value to display as selected
     * @param  bool    $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy
     * @param  integer $key            ID of the object to display as the root of select options
     * @param  string  $extra
     * @return string  HTML select box
     */
    public function alumni_makeSelBox($name, $fieldName, $prefix = '-', $selected = '', $addEmptyOption = false, $key = 0, $extra = '')

    {
        $xoops = Xoops::getInstance();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $ret   = '<select name="' . $name . '" id="' . $name . '" ' . $extra . '>';
        if (false != $addEmptyOption) {

            $ret .= '<option value="0">' . XoopsLocale::ALL . '</option>';
        }
        $this->alumni_makeSelBoxOptions($fieldName, $selected, $key, $ret, $prefix);

        return $ret . '</select>';
    }

    /**
     * Make options for a array
     *
     * @param  string  $fieldName Name of the member variable from the
     *                            node objects that should be used as the column.
     * @param  string  $prefix    String to indent deeper levels
     * @param  integer $key       ID of the object to display as the root of the array
     * @return array
     */
    public function alumni_makeArrayTree($fieldName, $prefix = '-', $key = 0)

    {
        $ret = [];
        $this->alumni_makeArrayTreeOptions($fieldName, $key, $ret, $prefix);

        return $ret;
    }

    /**
     * Make a array with options from the tree
     *
     * @param string  $fieldName   Name of the member variable from the
     *                             node objects that should be used as the column.
     * @param integer $key         ID of the object to display as the root of the array
     * @param         $ret
     * @param string  $prefix_orig String to indent deeper levels (origin)
     * @param string  $prefix_curr String to indent deeper levels (current)
     *
     * @return void
     */
    public function alumni_makeArrayTreeOptions($fieldName, $key, &$ret, $prefix_orig, $prefix_curr = '')

    {
        if ($key > 0) {
            $value       = $this->_tree[$key]['obj']->getVar($this->_myId);
            $ret[$value] = $prefix_curr . $this->_tree[$key]['obj']->getVar($fieldName);

            $prefix_curr .= $prefix_orig;

        }
        if (isset($this->_tree[$key]['child']) && !empty($this->_tree[$key]['child'])) {

            foreach ($this->_tree[$key]['child'] as $childkey) {
                $this->alumni_makeArrayTreeOptions($fieldName, $childkey, $ret, $prefix_orig, $prefix_curr);

            }
        }
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-12-19 09:37 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 33 and the first side effect is on line 24. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/*
3			You may not change or alter any portion of this comment or credits
4			of supporting developers from this source code or any supporting source code
5			which is considered copyrighted (c) material of the original comment or credit authors.
6
7			This program is distributed in the hope that it will be useful,
8			but WITHOUT ANY WARRANTY; without even the implied warranty of
9			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10			*/
11
12			/**
13			* XOOPS tree class
14			*
15			* @copyright XOOPS Project https://xoops.org/
16			* @license GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
17			* @package class
18			* @since 2.0.0
19			* @author Kazumi Ono (http://www.myweb.ne.jp/, http://jp.xoops.org/)
20			* @author Edited by John Mordo (jlm69)
21			* @version $Id$
22			*/
23
24			defined('XOOPS_ROOT_PATH') \|\| exit('XOOPS root path not defined');
25
26			/**
27			* A tree structures with {@link XoopsObject}s as nodes
28			*
29			* @package kernel
30			* @subpackage core
31			* @author Kazumi Ono <[email protected]>
32			*/
33			class AlumniObjectTree extends XoopsObjectTree
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-24 04:29 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
34			{
35			/**
36			* @var string
37			*/
38			private $_parentId;

mambax7 / alumni-26x

AlumniObjectTree::alumni_getAllChild() A last analyzed 2017-12-19 09:37 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AlumniObjectTree::alumni_getAllChild() A
last analyzed 2017-12-19 09:37 UTC