81 lines
2.0 KiB
PHP
81 lines
2.0 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 4th September, 2022
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Interfaces\Database;
|
|
|
|
|
|
/**
|
|
* Database Update
|
|
*
|
|
* @since 3.2.1
|
|
*/
|
|
interface UpdateInterface
|
|
{
|
|
/**
|
|
* Update a value to a given table
|
|
* Example: $this->value(Value, 'value_key', 'GUID');
|
|
*
|
|
* @param mixed $value The field value
|
|
* @param string $field The field key
|
|
* @param string $keyValue The key value
|
|
* @param string $key The key name
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function value($value, string $field, string $keyValue, string $key = 'guid'): bool;
|
|
|
|
/**
|
|
* Update single row with multiple values to a given table
|
|
* Example: $this->item(Array);
|
|
*
|
|
* @param array $item The item to save
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function row(array $item): bool;
|
|
|
|
/**
|
|
* Update multiple rows to a given table
|
|
* Example: $this->items(Array);
|
|
*
|
|
* @param array|null $items The items updated in database (array of arrays)
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function rows(?array $items): bool;
|
|
|
|
/**
|
|
* Update single item with multiple values to a given table
|
|
* Example: $this->item(Object);
|
|
*
|
|
* @param object $item The item to save
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function item(object $item): bool;
|
|
|
|
/**
|
|
* Update multiple items to a given table
|
|
* Example: $this->items(Array);
|
|
*
|
|
* @param array|null $items The items updated in database (array of objects)
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
public function items(?array $items): bool;
|
|
}
|
|
|