ntentan\nibii\Relationship

Complexity

Total Complexity

5

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

87.5%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setOptions()	0	3	1
A	getOptions()	0	3	1
A	getModelInstance()	0	7	2
A	setup()	0	6	1
	getQuery()	0	1	?
	runSetup()	0	1	?

<?php

/*
 * The MIT License
 *
 * Copyright 2015 ekow.
 *
 * 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.
 */

namespace ntentan\nibii;

abstract class Relationship {

    const BELONGS_TO = 'BelongsTo';
    const HAS_MANY = 'HasMany';
    const MANY_HAVE_MANY = 'ManyHaveMany';

    protected $options = [];
    protected $type;
    protected $setupName;
    protected $setupTable;
    protected $setupSchema;
    protected $setupPrimaryKey;
    
    /**
     *
     * @var \ntentan\panie\Container
     */
    protected $container;
    
    /**
     *
     * @var ORMContext
     */
    protected $context;
    
    private $setup = false;

    public function setOptions($options) {
        $this->options = $options;
    }

    public function getOptions() {
        return $this->options;
    }

    /**
     * Gets an instance of the related model accessed through this class.
     * @return RecordWrapper
     */
    public function getModelInstance() {
        if (!$this->setup) {
            $this->runSetup();
            $this->setup = true;
        }
        return $this->container->resolve($this->context->getClassName($this->options['model'], $this->type));
    }

    public function setup($name, $schema, $table, $primaryKey) {
        $this->setupName = $name;
        $this->setupTable = $table;
        $this->setupPrimaryKey = $primaryKey;
        $this->setupSchema = $schema;
    }

    abstract public function getQuery($data);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    abstract public function runSetup();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}