Delete

/ LJCPHPCodeDoc / LJCDataManagerLib / LJCDataManager / Delete

Parameters

$keyColumns - The where clause key columns.

Returns

The count of affected records.

Syntax

PHP
public function Delete(LJCDbColumns $keyColumns) : int

Deletes the records for the provided values.

Remarks

The Delete() method deletes records in the database.

The $keyColumns collection parameter contains the data for the where clause.

The $keyColumns parameter is required and must have collection elements or the Delete will not be executed.

Example

PHP
include_once "LJCRoot.php"; $prefix = RelativePrefix(); include_once "$prefix/LJCPHPCommon/LJCDataManagerLib.php"; include_once "$prefix/LJCPHPCommon/LJCDBAccessLib.php"; // See constructor for how to create $connectionValues. $tableName = "TableName"; $manager = new LJCDataManager($connectionValues, $tableName); $keyColumns = new DbColumns(); $keyColumns->Add("ID", value:1); $affectedCount = $manager->Delete($keyColumns); // $manager->SQL = // delete from TableName // where TableName.ID = 1;

PHP

 include_once "LJCRoot.php";
 $prefix = RelativePrefix();
 include_once "$prefix/LJCPHPCommon/LJCDataManagerLib.php";
 include_once "$prefix/LJCPHPCommon/LJCDBAccessLib.php";
 
 // See constructor for how to create $connectionValues.
 $tableName = "TableName";
 $manager = new LJCDataManager($connectionValues, $tableName);
 
 $keyColumns = new DbColumns();
 $keyColumns->Add("ID", value:1);
 $affectedCount = $manager->Delete($keyColumns);
 
 // $manager->SQL =
 // delete from TableName
 // where TableName.ID = 1;