Zepi\Turbo\Module\ModuleAbstract

Complexity

Total Complexity

6

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

60%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	initialize()	0	4	1
A	getInstance()	0	4	1
	activate()	0	1	?
A	deactivate()	0	4	1
A	getNamespace()	0	4	1
A	getDirectory()	0	4	1

<?php
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 zepi
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

/**
 * The abstract ModuleAbstract is the base for all modules
 * 
 * @package Zepi\Turbo\Module
 * @author Matthias Zobrist <matthias.zobrist@zepi.net>
 * @copyright Copyright (c) 2015 zepi
 */

namespace Zepi\Turbo\Module;

use \Zepi\Turbo\Framework;

/**
 * The abstract ModuleAbstract is the base for all modules
 * 
 * @author Matthias Zobrist <matthias.zobrist@zepi.net>
 * @copyright Copyright (c) 2015 zepi
 */
abstract class ModuleAbstract
{
    /**
     * @access protected
     * @var Framework
     */
    protected $framework;
    
    /**
     * @access protected
     * @var string
     */
    protected $namespace;
    
    /**
     * @access protected
     * @var string
     */
    protected $directory;
    
    /**
     * Constructs the object
     * 
     * @access public
     * @param \Zepi\Turbo\Framework $framework
     * @param string $namespace
     * @param string $directory
     */
    public function __construct(Framework $framework, $namespace, $directory)
    {
        $this->framework = $framework;
        $this->namespace = $namespace;
        $this->directory = $directory;
    }
    
    /**
     * Initializes the module
     * 
     * @access public
     */
    public function initialize()
    {
        
    }

    /**
     * Initializes and return an instance of the given class name.
     * 
     * @access public
     * @param string $className
     * @return mixed
     */
    public function getInstance($className)
    {
        return $this->framework->initiateObject($className);
    }
    
    /**
     * This action will be executed on the activation of the module
     * 
     * @access public
     * @abstract
     * @param string $versionNumber
     * @param string $oldVersionNumber
     */
    abstract public function activate($versionNumber, $oldVersionNumber = '');
    
    /**
     * This action will be executed on the deactiviation of the module
     * 
     * @access public
     */
    public function deactivate()
    {
        
    }
    
    /**
     * Returns the namespace of the module
     * 
     * @access public
     * @return string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }
    
    /**
     * Returns the directory of the module
     * 
     * @access public
     * @return string
     */
    public function getDirectory()
    {
        return $this->directory;
    }
}