public function UcAddressesAddressBook::deleteAddressById in Ubercart Addresses 7

Same name and namespace in other branches

1. 6.2 class/UcAddressesAddressBook.class.php \UcAddressesAddressBook::deleteAddressById()

Deletes an address by ID.

This will delete an address from the database.

@access public

Parameters

int $aid: The id of the address to delete.

Return value

boolean TRUE if the address is deleted. FALSE otherwise.

Throws

UcAddressesDbException

File

class/UcAddressesAddressBook.class.php, line 508

Contains the UcAddressesAddressBook class.

Class

UcAddressesAddressBook

The address book class

Code

public function deleteAddressById($aid) {
  return $this
    ->deleteOne(self::BY_AID, $aid);
}