BfwSql\Queries\JoinTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	joinRight()	0	4	1
A	joinLeft()	0	4	1
A	joinDefinePrefix()	0	5	1
A	createJoin()	0	9	1
A	join()	0	4	1

<?php

namespace BfwSql\Queries;

trait JoinTrait
{
    /**
     * Define the sql prefix to use for each join object
     * 
     * @return void
     */
    protected function joinDefinePrefix()
    {
        $this->queriesParts['join']->setPartPrefix('INNER JOIN');
        $this->queriesParts['joinLeft']->setPartPrefix('LEFT JOIN');
        $this->queriesParts['joinRight']->setPartPrefix('RIGHT JOIN');
    }
    
    /**
     * Add a INNER JOIN to the request
     * 
     * @return $this
     */
    public function join(...$args): self
    {
        array_unshift($args, 'join');
        return $this->createJoin(...$args);
    }
    
    /**
     * Add a LEFT JOIN to the request
     * 
     * @return $this
     */
    public function joinLeft(...$args): self
    {
        array_unshift($args, 'joinLeft');
        return $this->createJoin(...$args);
    }
    
    /**
     * Add a RIGHT JOIN to the request
     * 
     * @return $this
     */
    public function joinRight(...$args): self
    {
        array_unshift($args, 'joinRight');
        return $this->createJoin(...$args);
    }
    
    /**
     * Add a (inner|left|right) join to the request
     * 
     * @param string       $joinType The name of the property in this class
     *  where the join is add
     * @param string|array $table    Name of the table concerned by
     * the join. Or an array with the table shortcut in key.
     * @param string       $on       SQL part "ON" for this join
     * @param string|array $columns  Columns from the table joined to add in
     *  the SELECT part of the request
     * 
     * @return $this
     */
    protected function createJoin(
        string $joinType,
        $table,
        string $on,
        $columns = null
    ): self {
        $this->queriesParts[$joinType]($table, $on, $columns);
        
        return $this;
    }
}