Back to TableInterface class

Method delete

public bool
delete
(mixed $pk = null)
Method to delete a record.
Parameters
  • mixed $pk An optional primary key value to delete. If not set the instance property value is used.
Returns
  • bool True on success.
Since
  • 3.2
-
  • \UnexpectedValueException

Method delete - Source code

/**
 * Method to delete a record.
 *
 * @param   mixed  $pk  An optional primary key value to delete.  If not set the instance property value is used.
 *
 * @return  boolean  True on success.
 *
 * @since   3.2
 * @throws  \UnexpectedValueException
 */
public function delete($pk = null);