API15

JTableUser/delete

From Joomla! Documentation

< API15:JTableUser
Revision as of 17:17, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Default delete method <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </span...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Default delete method

[Edit Descripton]

Template:Description:JTableUser/delete

Syntax[edit]

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

Returns[edit]

true if successful otherwise returns and error message

Defined in[edit]

libraries/joomla/database/table/user.php

Importing[edit]

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

Source Body[edit]

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;
        }
}

[Edit See Also] Template:SeeAlso:JTableUser/delete

Examples[edit]

<CodeExamplesForm />