Project Pages

PHP Classes
SourceForge
Downloads
Archived Documentation

DB Connection Methods

objSQL
obj_close

Error Handling Methods

obj_error
obj_error_message

Statement Methods

obj_delete
obj_insert
obj_paging
obj_query
obj_select
obj_update

Statement Argument Methods

obj_batch_data
obj_cols
obj_data
obj_limit
obj_offset
obj_order_by
obj_sort_order
obj_table
obj_where

Resultset Methods

obj_affected_rows
obj_fetch_assoc
obj_fetch_num
obj_fetch_object
obj_field
obj_free_result
obj_num_fields
obj_num_rows

Prepared Statement Methods

obj_bind
obj_close_statement
obj_execute
obj_free_statement
obj_prepare_statement

Transaction Methods

obj_commit
obj_rollback
obj_savepoint
obj_transaction

Utility Methods

obj_escape
obj_info
obj_row_count

obj_delete()

Description:

Executes a delete statement with minimal SQL markup and is called from the objSQL class.

  • The table name argument is required unless using statement argument methods.
  • The optional where argument allows you to limit which rows are deleted and only requires the column and its value. You can use any of the normal operators used in SQL statements:
    • "location IN ('Athens','London')"
    • "location='Valdosta' AND dept='IT'"
    • "salary BETWEEN 20000 AND 40000"
  • obj_delete will delete all records from a database table if used without a where clause and steps should be taken in any script or program to utilize a confirmation before executing this method.

See also: Batch Delete Operations

Parameters:

mixed obj_delete ( [str table[, str where ]] )

Returns:

Result resource/object or false on failure.

Example:

<?php 

try 
{ 
    $rs = $dbh->obj_delete( "mytable", "dept='IT'" ); 
     
    if ( $dbh->obj_error() ) 
        throw new Exception( $dbh->obj_error_message() ); 
         
    echo $rs->obj_affected_rows(); 
     
} 
catch ( Exception $e )  
{ 
    //log error and/or redirect user to error page 
}  


try 
{ 
    //set arguments using statement argument helper methods 
    $dbh->obj_table( "mytable" );  
    $dbh->obj_where( "dept='IT'" );
    
    $rs = $dbh->obj_delete(); 
     
    if ( $dbh->obj_error() ) 
        throw new Exception( $dbh->obj_error_message() ); 
         
    echo $rs->obj_affected_rows(); 
     
} 
catch ( Exception $e )  
{ 
    //log error and/or redirect user to error page 
}  

?>

See also: obj_insert, obj_paging, obj_query, obj_select, obj_update

Batch Delete Example:

The obj_delete method with the obj_batch_data helper method allows you to easily perform batch delete operations.
  • It is highly recommended to perform batch operations within a Transaction block.
<?php     

try    
{    
    $trans = $dbh->obj_transaction();   
     
    //data argument can be an array or comma delimited string 
    //value should be a unique field in a row (ie: primary key, part #, mfg product #, etc. )  
    $data = array( 1234,2345,3456,4567,5678,6789 ); 
    $data = "1234,2345,3456,4567,5678,6789"; 
     
    //the second argument is the column name for the unique field 
    $dbh->obj_batch_data( $data, "employee_id" );   
     
    $dbh->obj_table( "employees" );   
            
    $rs = $dbh->obj_delete();    
        
    if ( $dbh->obj_error() )    
    {    
        $trans->obj_rollback();    
            
        throw new Exception( $dbh->obj_error_message() );    
    }  

    $trans->obj_commit();   
            
    echo $rs->obj_affected_rows();    
        
}    
catch ( Exception $e )     
{    
    //log error and/or redirect user to error page    
}     

?>   

See also: obj_batch_data