Add explicit `return null;` statements

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / DatabaseObjectEditor.class.php

<?php

namespace wcf\data;

use wcf\system\database\exception\DatabaseQueryExecutionException;
use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\WCF;

/**
 * Basic implementation for object editors following the decorator pattern.
 *
 * @author  Marcel Werk
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package WoltLabSuite\Core\Data
 */
abstract class DatabaseObjectEditor extends DatabaseObjectDecorator implements IEditableObject
{
    use TFastCreate {
        TFastCreate::fastCreate as private dboEditorCreateBase;
    }

    /**
     * @inheritDoc
     */
    public static function create(array $parameters = [])
    {
        return new static::$baseClass(static::dboEditorCreateBase($parameters));
    }

    /**
     * @inheritDoc
     */
    public function update(array $parameters = [])
    {
        if (empty($parameters)) {
            return;
        }

        $updateSQL = '';
        $statementParameters = [];
        foreach ($parameters as $key => $value) {
            if (!empty($updateSQL)) {
                $updateSQL .= ', ';
            }
            $updateSQL .= $key . ' = ?';
            $statementParameters[] = $value;
        }
        $statementParameters[] = $this->getObjectID();

        $sql = "UPDATE  " . static::getDatabaseTableName() . "
                SET     " . $updateSQL . "
                WHERE   " . static::getDatabaseTableIndexName() . " = ?";
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($statementParameters);
    }

    /**
     * @inheritDoc
     */
    public function updateCounters(array $counters = [])
    {
        if (empty($counters)) {
            return;
        }

        $updateSQL = '';
        $statementParameters = [];
        foreach ($counters as $key => $value) {
            if (!empty($updateSQL)) {
                $updateSQL .= ', ';
            }
            $updateSQL .= $key . ' = ' . $key . ' + ?';
            $statementParameters[] = $value;
        }
        $statementParameters[] = $this->getObjectID();

        $sql = "UPDATE  " . static::getDatabaseTableName() . "
                SET     " . $updateSQL . "
                WHERE   " . static::getDatabaseTableIndexName() . " = ?";
        $statement = WCF::getDB()->prepareStatement($sql);
        $statement->execute($statementParameters);
    }

    /**
     * @inheritDoc
     */
    public function delete()
    {
        static::deleteAll([$this->getObjectID()]);
    }

    /**
     * @inheritDoc
     */
    public static function deleteAll(array $objectIDs = [])
    {
        $affectedCount = 0;

        $itemsPerLoop = 1000;
        $loopCount = \ceil(\count($objectIDs) / $itemsPerLoop);

        WCF::getDB()->beginTransaction();
        for ($i = 0; $i < $loopCount; $i++) {
            $batchObjectIDs = \array_slice($objectIDs, $i * $itemsPerLoop, $itemsPerLoop);

            $conditionBuilder = new PreparedStatementConditionBuilder();
            $conditionBuilder->add(static::getDatabaseTableIndexName() . ' IN (?)', [$batchObjectIDs]);

            $sql = "DELETE FROM " . static::getDatabaseTableName() . "
                    " . $conditionBuilder;
            $statement = WCF::getDB()->prepareStatement($sql);
            $statement->execute($conditionBuilder->getParameters());
            $affectedCount += $statement->getAffectedRows();
        }
        WCF::getDB()->commitTransaction();

        return $affectedCount;
    }

    /**
     * Creates a new object, returns null if the row already exists.
     *
     * @param array $parameters
     * @return  IStorableObject|null
     * @since       5.3
     */
    public static function createOrIgnore(array $parameters = [])
    {
        try {
            return static::create($parameters);
        } catch (DatabaseQueryExecutionException $e) {
            // Error code 23000 = duplicate key
            if ($e->getCode() == '23000' && $e->getDriverCode() == '1062') {
                return null;
            }

            throw $e;
        }
    }
}