ActiveRecord::join() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/voku/s..." - voku/simple-mysqli - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( cd7afc...70524f )

by Lars
created 2018-11-11 21:42 UTC
ActiveRecord::join() A

↳ Parent: ActiveRecord
Complexity

Conditions	2
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	9
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	18
ccs	9
cts	9
cp	1
rs	9.6666
c	0
b	0
f	0
cc	2
nc	1
nop	3
crap	2
<?php

declare(strict_types=1);

namespace voku\db;

use Arrayy\Arrayy;
use voku\db\exceptions\ActiveRecordException;
use voku\db\exceptions\FetchingException;

/**
 * A simple implement of active record via Arrayy.
 *
 * @method $this select(string $dbProperty)
 * @method $this eq(string $dbProperty, string | int | null $value = null)
 * @method $this from(string $table)
 * @method $this where(string $where)
 * @method $this having(string $having)
 * @method $this limit(int $start, int | null $end = null)
 *
 * @method $this equal(string $dbProperty, string $value)
 * @method $this notEqual(string $dbProperty, string $value)
 * @method $this ne(string $dbProperty, string $value)
 * @method $this greaterThan(string $dbProperty, int $value)
 * @method $this gt(string $dbProperty, int $value)
 * @method $this lessThan(string $dbProperty, int $value)
 * @method $this lt(string $dbProperty, int $value)
 * @method $this greaterThanOrEqual(string $dbProperty, int $value)
 * @method $this ge(string $dbProperty, int $value)
 * @method $this gte(string $dbProperty, int $value)
 * @method $this lessThanOrEqual(string $dbProperty, int $value)
 * @method $this le(string $dbProperty, int $value)
 * @method $this lte(string $dbProperty, int $value)
 * @method $this between(string $dbProperty, array $value)
 * @method $this like(string $dbProperty, string $value)
 * @method $this in(string $dbProperty, array $value)
 * @method $this notIn(string $dbProperty, array $value)
 * @method $this isnull(string $dbProperty)
 * @method $this isNotNull(string $dbProperty)
 * @method $this notNull(string $dbProperty)
 */
abstract class ActiveRecord extends Arrayy
{
  const BELONGS_TO = 'belongs_to';
  const HAS_MANY   = 'has_many';
  const HAS_ONE    = 'has_one';

  const PREFIX = ':active_record';

  /**
   * Check "@property" types from class-phpdoc.
   *
   * @var bool
   */
  protected $checkPropertyTypes = true;

  /**
   * Check properties mismatch in the constructor.
   *
   * @var bool
   */
  protected $checkPropertiesMismatchInConstructor = false;


  /**
   * @var array <p>Mapping the function name and the operator, to build Expressions in WHERE condition.</p>
   *
   * call the function like this:
   * <pre>
   *   $user->isNotNull()->eq('id', 1);
   * </pre>
   *
   * the result in SQL:
   * <pre>
   *   WHERE user.id IS NOT NULL AND user.id = :ph1
   * </pre>
   */
  protected static $operators = [
      'equal'              => '=',
      'eq'                 => '=',
      'notequal'           => '<>',
      'ne'                 => '<>',
      'greaterthan'        => '>',
      'gt'                 => '>',
      'lessthan'           => '<',
      'lt'                 => '<',
      'greaterthanorequal' => '>=',
      'ge'                 => '>=',
      'gte'                => '>=',
      'lessthanorequal'    => '<=',
      'le'                 => '<=',
      'lte'                => '<=',
      'between'            => 'BETWEEN',
      'like'               => 'LIKE',
      'in'                 => 'IN',
      'notin'              => 'NOT IN',
      'isnull'             => 'IS NULL',
      'isnotnull'          => 'IS NOT NULL',
      'notnull'            => 'IS NOT NULL',
  ];

  /**
   * @var int <p>The count of bind params, using this count and const "PREFIX" (:ph) to generate place holder in
   *      SQL.</p>
   */
  private static $count = 0;

  /**
   * @var DB
   */
  protected $db;

  /**
   * @var array <p>Part of the SQL, mapping the function name and the operator to build SQL Part.</p>
   *
   * <br />
   *
   * call the function like this:
   * <pre>
   *      $user->orderBy('id DESC', 'name ASC')->limit(2, 1);
   * </pre>
   *
   * the result in SQL:
   * <pre>
   *      ORDER BY id DESC, name ASC LIMIT 2,1
   * </pre>
   */
  protected $sqlParts = [
      'select' => 'SELECT',
      'from'   => 'FROM',
      'set'    => 'SET',
      'where'  => 'WHERE',
      'group'  => 'GROUP BY',
      'having' => 'HAVING',
      'order'  => 'ORDER BY',
      'limit'  => 'LIMIT',
      'top'    => 'TOP',
  ];

  /**
   * @var array <p>The default sql expressions values.</p>
   */
  protected $defaultSqlExpressions = [
      'expressions' => [],
      'wrap'        => false,
      'select'      => null,
      'insert'      => null,
      'update'      => null,
      'set'         => null,
      'delete'      => 'DELETE ',
      'join'        => null,
      'from'        => null,
      'values'      => null,
      'where'       => null,
      'having'      => null,
      'limit'       => null,
      'order'       => null,
      'orderBy'     => null,
      'group'       => null,
  ];

  /**
   * @var array <p>Stored the Expressions of the SQL.</p>
   */
  protected $sqlExpressions = [];

  /**
   * @var string <p>The table name in database.</p>
   */
  protected $table;

  /**
   * @var string  <p>The primary key of this ActiveRecord, just support single primary key.</p>
   */
  protected $primaryKeyName = 'id';

  /**
   * @var array <p>Stored the dirty data of this object, when call "insert" or "update" function, will write this data
   *      into database.</p>
   */
  protected $dirty = [];

  /**
   * @var bool
   */
  protected $new_data_are_dirty = true;

  /**
   * @var array <p>Stored the params will bind to SQL when call DB->query().</p>
   */
  protected $params = [];

  /**
   * @var ActiveRecordExpressions[] <p>Stored the configure of the relation, or target of the relation.</p>
   */
  protected $relations = [];

  /**
   * Magic function to make calls witch in function mapping stored in $operators and $sqlPart.
   * also can call function of DB object.
   *
   * @param string $name <p>The name of the function.</p>
   * @param array  $args <p>The arguments of the function.</p>
   *
   * @return $this|mixed <p>Return the result of callback or the current object to make chain method calls.</p>
   *
   * @throws ActiveRecordException
   */
  public function __call(string $name, array $args = [])
  {
    if (!$this->db instanceof DB) {
      $this->db = DB::getInstance();

    }

    $nameTmp = \strtolower($name);

    if (\array_key_exists($nameTmp, self::$operators)) {

      $this->addCondition(
          $args[0],
          self::$operators[$nameTmp],
          $args[1] ?? null,
          (\is_string(\end($args)) && 'or' === \strtolower(\end($args))) ? 'OR' : 'AND'
      );

    } elseif (\array_key_exists($nameTmp = \str_replace('by', '', $nameTmp), $this->sqlParts)) {

      $this->{$name} = new ActiveRecordExpressions(
          [
              'operator' => $this->sqlParts[$nameTmp],
              'target'   => \implode(', ', $args),
          ]
      );

    } elseif (\is_callable($callback = [$this->db, $name])) {

      return \call_user_func_array($callback, $args);

    } else {

      throw new ActiveRecordException("Method $name not exist.");

    }

    return $this;
  }

  /**
   * Magic function to GET the values of current object.
   *
   * @param mixed $var
   *
   * @return mixed
   */
  public function &__get($var)
  {
    if (\array_key_exists($var, $this->sqlExpressions)) {
      return $this->sqlExpressions[$var];
    }

    if (\array_key_exists($var, $this->relations)) {
      return $this->getRelation($var);

    }

    if (isset($this->dirty[$var])) {
      return $this->dirty[$var];
    }

    return parent::__get($var);
  }

  /**
   * Magic function to SET values of the current object.
   *
   * @param string $var
   * @param mixed  $val
   */
  public function __set($var, $val)
  {
    if (
        \array_key_exists($var, $this->sqlExpressions)
        ||
        \array_key_exists($var, $this->defaultSqlExpressions)
    ) {

      $this->sqlExpressions[$var] = $val;

    } elseif (
        \array_key_exists($var, $this->relations)
        &&
        $val instanceof self
    ) {

      $this->relations[$var] = $val;

    } else {

      $this->set($var, $val);

      if ($this->new_data_are_dirty === true) {
        $this->dirty[$var] = $val;
      }

    }
  }

  /**
   * Magic function to UNSET values of the current object.
   *
   * @param mixed $var
   */
  public function __unset($var)
  {
    if (\array_key_exists($var, $this->sqlExpressions)) {
      unset($this->sqlExpressions[$var]);
    }

    if (isset($this->array[$var])) {
      unset($this->array[$var]);
    }

    if (isset($this->dirty[$var])) {
      unset($this->dirty[$var]);
    }
  }

  /**
   * Get a value from an array (optional using dot-notation).
   *
   * @param string $key       <p>The key to look for.</p>
   * @param mixed  $fallback  <p>Value to fallback to.</p>
   * @param array  $array     <p>The array to get from, if it's set to "null" we use the current array from the
   *                         class.</p>
   *
   * @return mixed
   */
  public function get($key, $fallback = null, array $array = null)
  {
    return parent::get($key, $fallback, $array);
  }

  /**
   * helper function to add condition into WHERE.
   *
   * @param ActiveRecordExpressions $expression <p>The expression will be concat into WHERE or SET statement.</p>
   * @param string                  $operator   <p>The operator to concat this Expressions into WHERE or SET
   *                                            statement.</p>
   * @param string                  $name       <p>The Expression will contact to.</p>
   */
  protected function _addCondition(ActiveRecordExpressions $expression, string $operator, string $name = 'where')
  {
    if (!$this->{$name}) {

      $this->{$name} = new ActiveRecordExpressions(
          [
              'operator' => \strtoupper($name),
              'target'   => $expression,
          ]
      );

    } else {

      $this->{$name}->target = new ActiveRecordExpressions(
          [
              'source'   => $this->{$name}->target,
              'operator' => $operator,
              'target'   => $expression,
          ]
      );

    }
  }

  /**
   * helper function to make wrapper. Stored the expression in to array.
   *
   * @param ActiveRecordExpressions $exp      <p>The expression will be stored.</p>
   * @param string                  $operator <p>The operator to concat this Expressions into WHERE statement.</p>
   */
  protected function _addExpression(ActiveRecordExpressions $exp, string $operator)
  {
    if (
        !\is_array($this->expressions)

        ||
        \count($this->expressions) === 0

    ) {
      $this->expressions = [$exp];

    } else {
      $this->expressions[] = new ActiveRecordExpressions(

          [
              'operator' => $operator,
              'target'   => $exp,
          ]
      );
    }
  }

  /**
   * Helper function to build SQL with sql parts.
   *
   * @param string[] $sql_array <p>The SQL part will be build.</p>
   *
   * @return string
   */
  protected function _buildSql(array $sql_array = []): string
  {
    \array_walk($sql_array, [$this, '_buildSqlCallback'], $this);

    // DEBUG
    //echo 'SQL: ', implode(' ', $sql_array), "\n", 'PARAMS: ', implode(', ', $this->params), "\n";

    return \implode(' ', $sql_array);
  }

  /**
   * Helper function to build SQL with sql parts.
   *
   * @param string $sql_string_part <p>The SQL part will be build.</p>
   * @param int    $index           <p>The index of $n in $sql array.</p>
   * @param self   $active_record   <p>The reference to $this.</p>
   */
  private function _buildSqlCallback(string &$sql_string_part, int $index, self $active_record)
  {
    if (
        'select' === $sql_string_part
        &&
        null === $active_record->{$sql_string_part}
    ) {

      $sql_string_part = \strtoupper($sql_string_part) . ' ' . $active_record->table . '.*';

    } elseif (
        (
            'update' === $sql_string_part
            ||
            'from' === $sql_string_part
        )
        &&
        null === $active_record->{$sql_string_part}
    ) {

      $sql_string_part = \strtoupper($sql_string_part) . ' ' . $active_record->table;

    } elseif ('delete' === $sql_string_part) {

      $sql_string_part = \strtoupper($sql_string_part) . ' ';

    } else {

      $sql_string_part = (null !== $active_record->{$sql_string_part}) ? $active_record->{$sql_string_part} . ' ' : '';

    }
  }

  /**
   * Helper function to build place holder when make SQL expressions.
   *
   * @param mixed $value <p>The value will be bind to SQL, just store it in $this->params.</p>
   *
   * @return mixed $value
   */
  protected function _filterParam($value)
  {
    if (\is_array($value)) {
      foreach ($value as $key => $val) {
        $this->params[$value[$key] = self::PREFIX . ++self::$count] = $val;
      }
    } elseif (\is_string($value)) {
      $this->params[$ph = self::PREFIX . ++self::$count] = $value;
      $value = $ph;
    }

    return $value;
  }

  /**
   * Helper function to add condition into WHERE.
   *
   * @param string $field           <p>The field name, the source of Expressions</p>
   * @param string $operator        <p>The operator for this condition.</p>
   * @param mixed  $value           <p>The target of the Expressions.</p>
   * @param string $operator_concat <p>The operator to concat this Expressions into WHERE or SET statement.</p>
   * @param string $name            <p>The Expression will contact to.</p>
   */
  public function addCondition(string $field, string $operator, $value, string $operator_concat = 'AND', string $name = 'where')
  {
    $value = $this->_filterParam($value);
    $expression = new ActiveRecordExpressions(
        [
            'source'   => ('where' === strtolower($name) ? $this->table . '.' : '') . $field,
            'operator' => $operator,
            'target'   => \is_array($value)
                ? new ActiveRecordExpressionsWrap(
                    'between' === \strtolower($operator)
                        ? ['target' => $value, 'start' => ' ', 'end' => ' ', 'delimiter' => ' AND ']
                        : ['target' => $value]
                ) : $value,
        ]
    );

    if ($expression) {
      if (!$this->wrap) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->_addCondition($expression, $operator_concat, $name);
      } else {
        $this->_addExpression($expression, $operator_concat);
      }
    }
  }

  /**
   * Helper function to copy an existing active record (and insert it into the database).
   *
   * @param bool $insert
   *
   * @return $this
   */
  public function copy(bool $insert = true): self
  {
    $new = clone $this;

    if ($insert) {
      $new->setPrimaryKey(null);
      $id = $new->insert();
      $new->setPrimaryKey($id);
    }

    return $new;
  }

  /**
   * Function to delete current record in database.
   *
   * @return bool
   */
  public function delete(): bool
  {
    $return = $this->execute(
        $this->eq($this->primaryKeyName, $this->{$this->primaryKeyName})->_buildSql(
            [
                'delete',
                'from',
                'where',
            ]
        ),
        $this->params
    );

    return $return !== false;
  }

  /**
   * Helper function to exec sql.
   *
   * @param string $sql   <p>The SQL need to be execute.</p>
   * @param array  $param <p>The param will be bind to the sql statement.</p>
   *
   * @return bool|int|Result              <p>
   *                                      "Result" by "<b>SELECT</b>"-queries<br />
   *                                      "int" (insert_id) by "<b>INSERT / REPLACE</b>"-queries<br />
   *                                      "int" (affected_rows) by "<b>UPDATE / DELETE</b>"-queries<br />
   *                                      "true" by e.g. "DROP"-queries<br />
   *                                      "false" on error
   *                                      </p>
   */
  public function execute(string $sql, array $param = [])
  {
    if (!$this->db instanceof DB) {
      $this->db = DB::getInstance();

    }

    return $this->db->query($sql, $param);
  }

  /**
   * Function to find one record and assign in to current object.
   *
   * @param mixed $id <p>
   *                  If call this function using this param, we will find the record by using this id.
   *                  If not set, just find the first record in database.
   *                  </p>
   *
   * @return false|$this <p>
   *                     If we could find the record, assign in to current object and return it,
   *                     otherwise return "false".
   *                     </p>
   */
  public function fetch($id = null)
  {
    if ($id) {
      $this->reset()->eq($this->primaryKeyName, $id);
    }

    $sqlQuery = $this->limit(1)->_buildSql(

        [
            'select',
            'from',
            'join',
            'where',
            'group',
            'having',
            'order',
            'limit',
        ]
    );

    $return = $this->query(
        $sqlQuery,
        $this->params,
        $this->reset(),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        true
    );

    return $return;
  }

  /**
   * Function to find all records in database.
   *
   * @param array|null $ids <p>
   *                        If call this function using this param, we will find the record by using this id's.
   *                        If not set, just find all records in database.
   *                        </p>
   *
   * @return $this[]
   */
  public function fetchAll(array $ids = null): array
  {
    if ($ids) {
      $this->reset()->in($this->primaryKeyName, $ids);
    }

    return $this->query(
        $this->_buildSql(
            [
                'select',
                'from',
                'join',
                'where',
                'groupBy',
                'having',
                'orderBy',
                'limit',
            ]
        ),
        $this->params,
        $this->reset()
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    );
  }

  /**
   * @param mixed $id
   *
   * @return $this
   *
   * @throws FetchingException <p>Will be thrown, if we can not find the id.</p>
   */
  public function fetchById($id): self
  {
    $obj = $this->fetchByIdIfExists($id);
    if ($obj === null) {
      throw new FetchingException("No row with primary key '$id' in table '$this->table'.");
    }

    return $obj;
  }

  /**
   * @param mixed $id
   *
   * @return $this|null
   */
  public function fetchByIdIfExists($id)
  {
    $list = $this->fetch($id);

    if (!$list) {
      return null;
    }

    return $list;
  }

  /**
   * @param array $ids
   *
   * @return $this[]
   */
  public function fetchByIds(array $ids): array
  {
    if (empty($ids)) {
      return [];
    }

    $list = $this->fetchAll($ids);
    if (\is_array($list) && \count($list) > 0) {
      return $list;
    }

    return [];
  }

  /**
   * @param array $ids
   *
   * @return $this[]
   */
  public function fetchByIdsPrimaryKeyAsArrayIndex(array $ids): array
  {
    $result = $this->fetchAll($ids);

    $resultNew = [];
    foreach ($result as $item) {
      $resultNew[$item->getPrimaryKey()] = $item;
    }

    return $resultNew;
  }

  /**
   * @param string $query
   *
   * @return $this[]|$this
   */
  public function fetchByQuery(string $query)
  {
    $list = $this->query(
        $query,
        $this->params,
        $this->reset()
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    );

    if (\is_array($list)) {
      if (\count($list) === 0) {
        return [];
      }

      return $list;
    }

    $this->array = $list->getArray();

    return $this;
  }

  /**
   * @return $this
   */
  public static function fetchEmpty(): self
  {
    $class = static::class;

    return new $class;
  }

  /**
   * @param string $query
   *
   * @return $this[]
   */
  public function fetchManyByQuery(string $query): array
  {
    $list = $this->fetchByQuery($query);

    if (!$list || empty($list)) {
      return [];
    }

    return $list;
  }

  /**
   * @param string $query
   *
   * @return $this|null
   */
  public function fetchOneByQuery(string $query)
  {
    $list = $this->fetchByQuery($query);

    if (!$list || empty($list)) {
      return null;
    }

    if (\is_array($list) && \count($list) > 0) {
      $this->array = $list[0]->getArray();
    } else {
      $this->array = $list->getArray();
    }

    return $this;
  }

  /**
   * @return array
   */
  public function getDirty(): array
  {
    return $this->dirty;
  }

  /**
   * @return array
   */
  public function getParams(): array
  {
    return $this->params;
  }

  /**
   * @return mixed|null
   */
  public function getPrimaryKey()
  {
    $id = $this->{$this->primaryKeyName};
    if ($id) {
      return $id;
    }

    return null;
  }

  /**
   * @return string
   */
  public function getPrimaryKeyName(): string
  {
    return $this->primaryKeyName;
  }

  /**
   * Helper function to get relation of this object.
   * There was three types of relations: {BELONGS_TO, HAS_ONE, HAS_MANY}
   *
   * @param string $name <p>The name of the relation (the array key from the definition).</p>
   *
   * @return mixed
   *
   * @throws ActiveRecordException <p>If the relation can't be found .</p>
   */
  protected function &getRelation(string $name)
  {
    $relation = $this->relations[$name];
    if (
        $relation instanceof self
        ||
        (
            \is_array($relation)
            &&
            $relation[0] instanceof self
        )
    ) {
      return $relation;
    }

    /* @var $obj ActiveRecord */
    $obj = new $relation[1];

    $this->relations[$name] = $obj;
    if (isset($relation[3]) && \is_array($relation[3])) {
      foreach ((array)$relation[3] as $func => $args) {
        \call_user_func_array([$obj, $func], (array)$args);
      }
    }

    $backref = $relation[4] ?? '';
    $relationInstanceOfSelf = ($relation instanceof self);
    if (
        $relationInstanceOfSelf === false
        &&
        self::HAS_ONE == $relation[0]
    ) {

      $this->relations[$name] = $obj->eq((string)$relation[2], $this->{$this->primaryKeyName})->fetch();

      if ($backref) {
        $this->relations[$name] && $backref && $obj->{$backref} = $this;
      }

    } elseif (
        \is_array($relation)
        &&
        self::HAS_MANY == $relation[0]
    ) {

      $this->relations[$name] = $obj->eq((string)$relation[2], $this->{$this->primaryKeyName})->fetchAll();
      if ($backref) {
        foreach ($this->relations[$name] as $o) {
          $o->{$backref} = $this;
        }
      }

    } elseif (
        $relationInstanceOfSelf === false
        &&
        self::BELONGS_TO == $relation[0]
    ) {

      $this->relations[$name] = $obj->eq($obj->primaryKeyName, $this->{$relation[2]})->fetch();

      if ($backref) {
        $this->relations[$name] && $backref && $obj->{$backref} = $this;
      }

    } else {
      throw new ActiveRecordException("Relation $name not found.");
    }

    return $this->relations[$name];
  }

  /**
   * @return string
   */
  public function getTable(): string
  {
    return $this->table;
  }

  /**
   * Helper function for "GROUP BY".
   *
   * @param mixed $args
   *
   * @return $this
   */
  public function groupBy($args): self

  {
    $this->__call('groupBy', \func_get_args());

    return $this;
  }

  /**
   * Function to build insert SQL, and insert current record into database.
   *
   * @return bool|int <p>
   *                  If insert was successful, it will return the new id,
   *                  otherwise it will return false or true (if there are no dirty data).
   *                  </p>
   */
  public function insert()
  {
    if (!$this->db instanceof DB) {
      $this->db = DB::getInstance();

    }

    if (\count($this->dirty) === 0) {
      return true;
    }

    $value = $this->_filterParam($this->dirty);
    $this->insert = new ActiveRecordExpressions(
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        [
            'operator' => 'INSERT INTO ' . $this->table,
            'target'   => new ActiveRecordExpressionsWrap(['target' => \array_keys($this->dirty)]),
        ]
    );
    $this->values = new ActiveRecordExpressions(
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        [
            'operator' => 'VALUES',
            'target'   => new ActiveRecordExpressionsWrap(['target' => $value]),
        ]
    );

    $result = $this->execute($this->_buildSql(['insert', 'values']), $this->params);
    if ($result !== false) {
      $this->{$this->primaryKeyName} = $result;

      $this->resetDirty();
      $this->reset();

      return $result;
    }

    return false;
  }

  /**
   * @return bool
   */
  public function isNewDataAreDirty(): bool
  {
    return $this->new_data_are_dirty;
  }

  /**
   * Helper function to add condition into JOIN.
   *
   * @param string $table <p>The join table name.</p>
   * @param string $on    <p>The condition of ON.</p>
   * @param string $type  <p>The join type, like "LEFT", "INNER", "OUTER".</p>
   *
   * @return $this
   */
  public function join(string $table, string $on, string $type = 'LEFT'): self
  {
    $this->join = new ActiveRecordExpressions(
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        [
            'source'   => $this->join ?: '',
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'operator' => $type . ' JOIN',
            'target'   => new ActiveRecordExpressions(
                [
                    'source'   => $table,
                    'operator' => 'ON',
                    'target'   => $on,
                ]
            ),
        ]
    );

    return $this;
  }

  /**
   * Helper function for "ORDER BY".
   *
   * @param mixed $args
   *
   * @return $this
   */
  public function orderBy($args): self

  {
    $this->__call('orderBy', \func_get_args());

    return $this;
  }

  /**
   * Helper function to query one record by sql and params.
   *
   * @param string    $sql            <p>
   *                                  The SQL query to find the record.
   *                                  </p>
   * @param array     $param          <p>
   *                                  The param will be bind to the $sql query.
   *                                  </p>
   * @param null|self $obj            <p>
   *                                  The object, if find record in database, we will assign the attributes into
   *                                  this object.
   *                                  </p>
   * @param bool      $single         <p>
   *                                  If set to true, we will find record and fetch in current object, otherwise
   *                                  will find all records.
   *                                  </p>
   *
   * @return bool|$this|$this[]
   */
  public function query(string $sql, array $param = [], self $obj = null, bool $single = false)
  {
    $result = $this->execute($sql, $param);

    if ($result === false) {
      return false;
    }

    $useObject = \is_object($obj);
    if ($useObject === true) {
      $called_class = $obj;
    } else {
      $called_class = static::class;
    }

    $this->setNewDataAreDirty(false);

    if ($single) {
      $return = $result->fetchObject($called_class, null, true);
    } else {
      $return = $result->fetchAllObject($called_class, null);
    }

    $this->setNewDataAreDirty(true);

    return $return;
  }

  /**
   * Function to reset the $params and $sqlExpressions.
   *
   * @return $this
   */
  public function reset(): self
  {
    $this->params = [];
    $this->sqlExpressions = [];

    return $this;
  }

  /**
   * Reset the dirty data.
   *
   * @return $this
   */
  public function resetDirty(): self
  {
    $this->dirty = [];

    return $this;
  }

  /**
   * set the DB connection.
   *
   * @param DB $db
   */
  public function setDb(DB $db)
  {
    $this->db = $db;
  }

  /**
   * @param bool $bool
   */
  public function setNewDataAreDirty(bool $bool)
  {
    $this->new_data_are_dirty = $bool;
  }

  /**
   * @param mixed $primaryKey
   * @param bool  $dirty
   *
   * @return $this
   */
  public function setPrimaryKey($primaryKey, bool $dirty = true): self
  {
    if (\property_exists($this, $this->primaryKeyName)) {
      $this->{$this->primaryKeyName} = $primaryKey;
    }

    if ($dirty === true) {
      $this->dirty[$this->primaryKeyName] = $primaryKey;
    } else {
      $this->array[$this->primaryKeyName] = $primaryKey;
    }

    return $this;
  }

  /**
   * @param string $primaryKeyName
   *
   * @return $this
   */
  public function setPrimaryKeyName(string $primaryKeyName): self
  {
    $this->primaryKeyName = $primaryKeyName;

    return $this;
  }

  /**
   * @param string $table
   */
  public function setTable(string $table)
  {
    $this->table = $table;
  }

  /**
   * Function to build update SQL, and update current record in database, just write the dirty data into database.
   *
   * @return bool|int <p>
   *                  If update was successful, it will return the affected rows as int,
   *                  otherwise it will return false or true (if there are no dirty data).
   *                  </p>
   */
  public function update()
  {
    if (\count($this->dirty) == 0) {
      return true;
    }

    foreach ($this->dirty as $field => $value) {
      $this->addCondition($field, '=', $value, ',', 'set');
    }

    $result = $this->execute(
        $this->eq($this->primaryKeyName, $this->{$this->primaryKeyName})->_buildSql(
            [
                'update',
                'set',
                'where',
            ]
        ),
        $this->params
    );
    if ($result !== false) {
      $this->resetDirty();
      $this->reset();

      return $result;
    }

    return false;
  }

  /**
   * Make wrap when build the SQL expressions of WHERE.
   *
   * @param string $op <p>If given, this param will build one "ActiveRecordExpressionsWrap" and include the stored
   *                   expressions add into WHERE, otherwise it will stored the expressions into an array.</p>
   *
   * @return $this
   */
  public function wrap($op = null): self
  {
    if (1 === \func_num_args()) {
      $this->wrap = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
      if (\is_array($this->expressions) && \count($this->expressions) > 0) {

        $this->_addCondition(
            new ActiveRecordExpressionsWrap(
                [
                    'delimiter' => ' ',
                    'target'    => $this->expressions,

                ]
            ),
            'or' === \strtolower($op) ? 'OR' : 'AND'
        );
      }
      $this->expressions = [];

    } else {
      $this->wrap = true;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    return $this;
  }
}

voku / simple-mysqli

Push — master ( cd7afc...70524f )

ActiveRecord::join() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
