alexdodonov / mezon-service

DbServiceModel.php

<?php
namespace Mezon\Service;

/**
 * Class DbServiceModel
 *
 * @package Service
 * @subpackage DbServiceModel
 * @author Dodonov A.A.
 * @version v.1.0 (2019/10/18)
 * @copyright Copyright (c) 2019, aeon.org
 */

/**
 * Default DB model for the service
 *
 * @author Dodonov A.A.
 */
class DbServiceModel extends \Mezon\Service\ServiceModel
{

    use \Mezon\PdoCrud\ConnectionTrait;

    /**
     * Table name
     */
    private $tableName = '';

    /**
     * Fields algorithms
     */
    private $fieldsSet = false;

    /**
     * Entity name
     */
    private $entityName = false;

    /**
     * Constructor
     *
     * @param string|array $fields
     *            fields of the model
     * @param string $tableName
     *            name of the table
     * @param string $entityName
     *            name of the entity
     */
    public function __construct($fields = '*', string $tableName = '', string $entityName = '')
    {
        $this->setTableName($tableName);

        $this->entityName = $entityName;

        if (is_string($fields)) {
            $this->fieldsSet = new \Mezon\FieldsSet(
                [
                    '*' => [
                        'type' => 'string',
                        'title' => 'All fields'
                    ]
                ]);
        } elseif (is_array($fields)) {

The condition is_array($fields) is always true.

            $this->fieldsSet = new \Mezon\FieldsSet($fields);
        } elseif ($fields instanceof \Mezon\FieldsSet) {
            $this->fieldsSet = $fields;
        } else {
            throw (new \Exception('Invalid fields description', - 1));
        }
    }

    /**
     * Method sets table name
     *
     * @param string $tableName
     *            Table name
     */
    protected function setTableName(string $tableName = ''): void
    {
        if (strpos($tableName, '-') !== false && strpos($tableName, '`') === false) {
            $tableName = "`$tableName`";
        }

        $this->tableName = $tableName;
    }

    /**
     * Method returns table name
     *
     * @return string table name
     */
    public function getTableName(): string
    {
        return $this->tableName;
    }

    /**
     * Method returns list of all fields as string
     *
     * @return string list of all fields as string
     */
    public function getFieldsNames(): string
    {
        return implode(', ', $this->fieldsSet->getFieldsNames());
    }

    /**
     * Method returns true if the field exists
     *
     * @param string $fieldName
     *            Field name
     * @return bool
     */
    public function hasField(string $fieldName): bool
    {
        return $this->fieldsSet->hasField($fieldName);
    }

    /**
     * Method returns true if the custom field exists
     *
     * @return bool
     */
    public function hasCustomFields(): bool
    {
        return $this->fieldsSet->hasCustomFields();
    }

    /**
     * Method validates if the field $field exists
     *
     * @param string $field
     *            Field name
     */
    public function validateFieldExistance(string $field)
    {
        return $this->fieldsSet->validateFieldExistance($field);

Are you sure the usage of $this->fieldsSet->validateFieldExistance($field) targeting Mezon\FieldsSet::validateFieldExistance() seems to always return null.

    }

    /**
     * Method returns fields list
     *
     * @return array Fields list
     */
    public function getFields(): array
    {
        return $this->fieldsSet->getFieldsNames();
    }

    /**
     * Method returns entity name
     *
     * @return string Entity name
     */
    public function getEntityName(): string
    {
        return $this->entityName;
    }

    /**
     * Method returns field type
     *
     * @param string $fieldName
     *            field name
     * @return string field type
     */
    public function getFieldType(string $fieldName): string
    {
        return $this->fieldsSet->getFieldType($fieldName);
    }
}