intraface / intraface.dk

src/Intraface/Kernel.php

<?php
/**
 * Kernel - a registry
 *
 * @package Intraface
 * @author  Sune Jensen <sj@sunet.dk>
 * @author  Lars Olesen <lars@legestue.net>
 * @since   0.1.0
 * @version @package-version@
 */
class Intraface_Kernel implements Intraface_Identity
{
    private $db;
    public $intranet;
    public $user;
    private $_session;
    public $session_id;
    /*

58% of this comment could be valid code. Did you maybe forget this after debugging?

    public $modules = array();
    public $shared;
    private $primary_module_name;
    */
    public $translation;
    private $observers = array();

The property $observers is not used and could be removed.

    private $modulehandler;
    public $setting;

    /**
     * Constructor
     *
     * @param string $session Session string
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    function __construct($session = null)
    {
        if ($session == null) {

It seems like you are loosely comparing $session of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            $this->_session = md5(uniqid(rand(), true));
        } else {
            $this->_session = $session;
        }
        $this->db = MDB2:: singleton(DB_DSN);
        if (PEAR::isError($this->db)) {
            throw new Exception($this->db->getMessage() . $this->db->getUserInfo());
        }
    }

    /**
     * returns an unique user id for this login
     *
     * @todo: session_id is not the correct name, as this is not always session id.
     */
    function getSessionId()
    {
        return $this->_session;
    }

    function getModuleHandler()
    {
        if (!empty($this->modulehandler)) {
            return $this->modulehandler;
        }
        return ($this->modulehandler = new Intraface_ModuleHandler($this->intranet, $this->user));

$this->intranet is of type object<Intraface_Intranet>|object<FakeKernelIntranet>|object<FakeKernelIntranetWithNoAccess>|object<FakeDebtorIntranet>, but the function expects a string.

$this->user is of type object<Intraface_User>|object<FakeKernelIntranetWithNoAccess>|object<FakeKernelIntranet>|object<FakeDebtorUser>, but the function expects a string.

    }

    /**
     * Sets primary module for a page
     *
     * @param string $module_name Name on module
     *
     * @return Module object
     */
    function module($module_name)
    {
        return $this->getModuleHandler()->setPrimaryModule($module_name);
    }

    /**
     * Returns the primary module
     *
     * Used for instance in Page to give the correct submenu.
     *
     * @return module object or false
     */
    function getPrimaryModule()
    {
        return $this->getModuleHandler()->getPrimaryModule();
    }

    /**
     * Gets a module
     *
     * @param string $name of the module
     *
     * @return module object or false
     */
    function getModule($name)
    {
        return $this->getModuleHandler()->getModule($name);
    }

    /**
     * Gets a list of modules - is used on frontpage and under rights
     *
     * @param string $order_by which index
     *
     * @return array with modules
     */
    function getModules($order_by = 'frontpage_index')
    {
        return $this->getModuleHandler()->getModules($this->db, $order_by);
    }

    /**
     * Use another module besides the primary
     *
     * @param string  $module_name        Navn p� det modullet der skal loades
     * @param boolean $ignore_user_access Ved true, tjekker den ikke om brugeren har adgang, men kun om intranettet har. Benyttes bla. til n�r der skal tr�kkes vare fra lageret fra gennem faktura.
     *
     * @return object or false Hvis man har adgang returnere den et object, ellers returnere den 0;
     */
    function useModule($module_name, $ignore_user_access = false)

The parameter $ignore_user_access is not used and could be removed.

    {
        return $this->getModuleHandler()->useModule($module_name, $ignore_user_access = false);
    }

    /**
     * Public: Giv adgang til et shared
     *
     * @param string $shared_name Navn p� det shared der skal loades
     *
     * @return object or 0 Hvis man har adgang returnere den et object, ellers returnere den 0;
     */
    function useShared($shared_name)
    {
        return $this->getModuleHandler()->useShared($shared_name);
    }

    /**
     * Returns translation object and sets page_id
     * Could be moved when there is no more calls to the method.
     *
     * @param string $page_id Which specific translation object is needed
     *
     * @return Translation object
     */
    function getTranslation($page_id = 'common')
    {
        if (is_object($this->translation)) {
            if (!empty($page_id)) {
                $this->translation->setPageID($page_id);
            }
            return $this->translation;
        }

        if (isset($this->translation)) {
            $this->translation->setPageID($page_id);
        }

        return $this->translation;
    }

    /**
     * Function to make a random key - e.g. for passwords
     * This functions don't return any characters whick can be mistaken.
     * Won't return 0 (zero) or o (as in Ole) or 1 (one) or l (lars), because they can be mistaken on print.
     *
     * @param $count (integer) how many characters to return?
     *
     * @return  random key (string) only letters
     */
    function randomKey($length = 1)
    {
        $random = new Ilib_RandomKeyGenerator();
        return $random->generate($length);
    }

    function getIntranet()
    {
        return $this->intranet;
    }

    function getSetting()
    {
        // Very important to store setting, as getSetting is called many times in some scripts
        if (empty($this->setting)) {
            if (is_object($this->user)) {
                $user_id = $this->user->getId();
            } else {
                $user_id = 0;
            }
            $this->setting = new Intraface_Setting($this->intranet->getId(), $user_id);

The method getId does only exist in FakeDebtorIntranet and Intraface_Intranet, but not in FakeKernelIntranet and FakeKernelIntranetWithNoAccess.

        }

        return $this->setting;
    }

    function getId()
    {
        return $this->user->getId();

The method getId does only exist in Intraface_User, but not in FakeDebtorUser and FakeKernelIntranet and FakeKernelIntranetWithNoAccess.

    }

    function getActiveIntranetId()
    {
        return $this->user->getActiveIntranetId();

The method getActiveIntranetId does only exist in Intraface_User, but not in FakeDebtorUser and FakeKernelIntranet and FakeKernelIntranetWithNoAccess.

    }
}