Actions

API15

JTableUser/delete

From Joomla! Documentation

< API15:JTableUser
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Default delete method

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

delete($oid=null)
Parameter Name Default Value Description
$oid null

Returns

true if successful otherwise returns and error message

Defined in

libraries/joomla/database/table/user.php

Importing

jimport( 'joomla.database.table.user' );

Source Body

function delete( $oid=null )
{
        $acl =& JFactory::getACL();
 
        $k = $this->_tbl_key;
        if ($oid) {
                $this->$k = intval( $oid );
        }
        $aro_id = $acl->get_object_id( 'users', $this->$k, 'ARO' );
        $acl->del_object( $aro_id, 'ARO', true );
 
        $query = 'DELETE FROM '. $this->_tbl
        . ' WHERE '. $this->_tbl_key .' = '. (int) $this->$k
        ;
        $this->_db->setQuery( $query );
 
        if ($this->_db->query()) {
                // cleanup related data
 
                // private messaging
                $query = 'DELETE FROM #__messages_cfg'
                . ' WHERE user_id = '. (int) $this->$k
                ;
                $this->_db->setQuery( $query );
                if (!$this->_db->query()) {
                        $this->setError( $this->_db->getErrorMsg() );
                        return false;
                }
                $query = 'DELETE FROM #__messages'
                . ' WHERE user_id_to = '. (int) $this->$k
                ;
                $this->_db->setQuery( $query );
                if (!$this->_db->query()) {
                        $this->setError( $this->_db->getErrorMsg() );
                        return false;
                }
 
                return true;
        } else {
                $this->setError( $this->_db->getErrorMsg() );
                return false;
        }
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />