keeko\tools\model\Relationship

Complexity

Total Complexity

6

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
	getType()	0	1	?
A	getModel()	0	3	1
A	getForeign()	0	3	1
A	getForeignKey()	0	3	1
	getRelatedName()	0	1	?
A	getRelatedPluralName()	0	3	1
A	getRelatedTypeName()	0	3	1
A	getRelatedPluralTypeName()	0	3	1
	getReverseRelatedName()	0	1	?

<?php
namespace keeko\tools\model;

use Propel\Generator\Model\ForeignKey;
use Propel\Generator\Model\Table;
use keeko\framework\utils\NameUtils;

abstract class Relationship {
	
	const ONE_TO_ONE = 'one-to-one';
	const ONE_TO_MANY = 'one-to-many';
	const MANY_TO_MANY = 'many-to-many';

	/** @var Table */
	protected $model;

	/** @var Table */
	protected $foreign;

	/** @var ForeignKey */
	protected $fk;
	
	/**
	 * Returns the type of this relationship
	 * 
	 * @return string
	 */
	abstract public function getType();

	/**
	 * Returns the model
	 * 
	 * @return Table
	 */
	public function getModel() {
		return $this->model;
	}

	/**
	 * Returns the foreign model
	 * 
	 * @return Table
	 */
	public function getForeign() {
		return $this->foreign;
	}

	/**
	 * Returns the foreign key
	 * 
	 * @return ForeignKey
	 */
	public function getForeignKey() {
		return $this->fk;
	}
	
	/**
	 * Returns the related name in studly case
	 *
	 * @return string
	 */
	abstract public function getRelatedName();

	/**
	 * Returns the pluralized related name in studly case
	 *
	 * @return string
	 */
	public function getRelatedPluralName() {
		return NameUtils::pluralize($this->getRelatedName());
	}
	
	/**
	 * Returns the related type name for usage in api environment (slug, type-name, etc)
	 *
	 * @return string
	 */
	public function getRelatedTypeName() {
		return NameUtils::dasherize($this->getRelatedName());
	}
	
	/**
	 * Returns the pluralized related type name for usage in api environment (slug, type-name, etc)
	 * 
	 * @return string
	 */
	public function getRelatedPluralTypeName() {
		return NameUtils::pluralize($this->getRelatedTypeName());
	}
	
	/**
	 * Returns the reverse related name in studly case
	 */
	abstract public function getReverseRelatedName();

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.

}