bulton-fr / bfw-sql

src/AbstractModels.php

<?php

namespace BfwSql;

use \Exception;

/**
 * Abstract class for all Models class
 * 
 * @package bfw-sql
 * @author Vermeulen Maxime <bulton.fr@gmail.com>
 * @version 2.0
 */
abstract class AbstractModels extends \BfwSql\Sql
{
    /**
     * @const ERR_NO_CONNECTION_CONFIGURED Exception code if no connection
     * is configured.
     */
    const ERR_NO_CONNECTION_CONFIGURED = 2101001;
    
    /**
     * @const ERR_NEED_BASEKEYNAME_DEFINED Exception code if the baseKeyName
     * should be defined (multiple connection) but it's not.
     */
    const ERR_NEED_BASEKEYNAME_DEFINED = 2101002;
    
    /**
     * @const ERR_UNKNOWN_CONNECTION_FOR_BASEKEYNAME Exception code if the
     * baseKeyName defined corresponding to no defined connection.
     */
    const ERR_UNKNOWN_CONNECTION_FOR_BASEKEYNAME = 2101003;
    
    /**
     * @var string $tableName The table name
     */
    protected $tableName = '';
    
    /**
     * @var string $tableNameWithPrefix the table name with prefix
     */
    protected $tableNameWithPrefix = '';
    
    /**
     * @var string $alias The table alias to use into queries
     */
    protected $alias = '';
    
    /**
     * @var string $baseKeyName The baseKeyName to use to connection.
     *  Use it if they are multiple database to connect in the application.
     */
    protected $baseKeyName = '';
    
    /**
     * Constructor
     */
    public function __construct()
    {
        $sqlConnect = $this->obtainSqlConnect();
        
        parent::__construct($sqlConnect);
        $this->tableNameWithPrefix = $this->prefix.$this->tableName;
    }
    
    /**
     * Getter to property tableName
     * 
     * @return string
     */
    public function getTableName(): string
    {
        return $this->tableName;
    }
    
    /**
     * Getter to property tableNameWithPrefix
     * 
     * @return string
     */
    public function getTableNameWithPrefix(): string
    {
        return $this->tableNameWithPrefix;
    }
    
    /**
     * Getter to property alias
     * 
     * @return string
     */
    public function getAlias(): string
    {
        return $this->alias;
    }
    
    /**
     * Getter to property baseKeyName
     * 
     * @return string
     */
    public function getBaseKeyName(): string
    {
        return $this->baseKeyName;
    }
    
    /**
     * Get the BFW Application
     * It's a dedicated method for unit test or case where App is override
     * 
     * @return \BFW\Application
     */
    protected function obtainApp(): \BFW\Application
    {
        return \BFW\Application::getInstance();
    }
    
    /**
     * Obtain SqlConnect instance for the baseKeyName
     * 
     * @return \BfwSql\SqlConnect
     * 
     * @throws \Exception If there are many connection declared and if the
     *  property baseKeyName is empty
     */
    protected function obtainSqlConnect(): \BfwSql\SqlConnect
    {
        $listBases = $this->obtainApp()
            ->getModuleList()
            ->getModuleByName('bfw-sql')
            ->listBases;
        
        if (count($listBases) === 0) {
            throw new Exception(
                'There is no connection configured.',
                self::ERR_NO_CONNECTION_CONFIGURED
            );
        }
        
        if (count($listBases) > 1 && empty($this->baseKeyName)) {
            throw new Exception(
                'There are multiple connection, '
                .'so the property baseKeyName must be defined',
                self::ERR_NEED_BASEKEYNAME_DEFINED
            );
        }
        
        if (count($listBases) > 1 && !isset($listBases[$this->baseKeyName])) {
            throw new Exception(
                'There are multiple connection, '
                .'but the connection '.$this->baseKeyName.' is not defined.',
                self::ERR_UNKNOWN_CONNECTION_FOR_BASEKEYNAME
            );
        }
        
        if (count($listBases) === 1) {
            $sqlConnect = reset($listBases);
        } else {
            $sqlConnect = $listBases[$this->baseKeyName];
        }
        
        return $sqlConnect;
    }
    
    public function obtainTableInfos()
    {
        if (empty($this->alias)) {
            return $this->tableName;
        }
        
        return [$this->alias => $this->tableName];
    }
    
    public function select(string $type = 'array'): \BfwSql\Queries\Select
    {
        return parent::select($type)
            ->from($this->obtainTableInfos())

The method from() does not exist on BfwSql\Queries\Select. Since you implemented __call, consider adding a @method annotation.

        ;
    }
    
    public function insert(
        string $quoteStatus = \BfwSql\Helpers\Quoting::QUOTE_ALL
    ): \BfwSql\Queries\Insert {
        return parent::insert($quoteStatus)
            ->into($this->obtainTableInfos())
        ;
    }
    
    public function update(
        string $quoteStatus = \BfwSql\Helpers\Quoting::QUOTE_ALL
    ): \BfwSql\Queries\Update {
        return parent::update($quoteStatus)
            ->from($this->obtainTableInfos())
        ;
    }
    
    public function delete(): \BfwSql\Queries\Delete
    {
        return parent::delete()
            ->from($this->obtainTableInfos())
        ;
    }
}