API17:JTableNested::delete
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JTableNested::delete|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JTableNested::delete|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function delete ( |
| + | $pk=null | ||
| + | $children=true | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 32: | Line 32: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True on success. | |
| − | boolean True on success. | + | * '''Defined''' on line 503 of libraries/joomla/database/tablenested.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/database/tablenested.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JTableNested::delete source code''' on [[jplatform:database/tablenested.php#cl-495|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JTableNested/11.1|JTableNested]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]] | ||
| + | * [[JTableNested::delete|Other versions of JTableNested::delete]] | ||
| + | {{SeeAlso:JTableNested::delete}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JTableNested::delete|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JTableNested::delete|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 53: | Line 52: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JTableNested]][[Category:JTableNested::delete]]</noinclude> | <noinclude>[[Category:JTableNested]][[Category:JTableNested::delete]]</noinclude> | ||
Revision as of 21:48, 27 April 2011
JTableNested::delete
Description
Method to delete a node, and optionally its child nodes, from the table.
Description:JTableNested::delete [Edit Descripton]
public function delete ( $pk=null $children=true )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $pk | integer | null | The primary key of the node to delete. |
| $children | boolean | true | True to delete child nodes, false to move them up a level. |
- Returns boolean True on success.
- Defined on line 503 of libraries/joomla/database/tablenested.php
- Since
See also
- JTableNested::delete source code on BitBucket
- Class JTableNested
- Subpackage Database
- Other versions of JTableNested::delete
SeeAlso:JTableNested::delete [Edit See Also]
User contributed notes
<CodeExamplesForm />
