Actions

API17

Difference between revisions of "JModelAdmin"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JModelAdmin==
 +
===Description===
 +
{{Description:JModelAdmin}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JModelAdmin|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JModelAdmin|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JModelAdmin}}
 
===Defined in===
 
libraries/joomla/application/component/modeladmin.php
 
* see source code in [[jplatform:application/component/modeladmin.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Application/11.1|Application]]
 
===Extends===
 
[[JModelForm/11.1|JModelForm]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::__construct/11.1|__construct]]
 
|[[JModelAdmin::__construct/11.1|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::checkin/11.1|checkin]]
 
|[[JModelAdmin::checkin/11.1|checkin]]
 
|Method override to check-in a record or an array of record.  
 
|Method override to check-in a record or an array of record.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::checkout/11.1|checkout]]
 
|[[JModelAdmin::checkout/11.1|checkout]]
 
|Method override to check-out a record.  
 
|Method override to check-out a record.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::delete/11.1|delete]]
 
|[[JModelAdmin::delete/11.1|delete]]
 
|Method to delete one or more records.  
 
|Method to delete one or more records.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::getItem/11.1|getItem]]
 
|[[JModelAdmin::getItem/11.1|getItem]]
 
|Method to get a single record.  
 
|Method to get a single record.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::publish/11.1|publish]]
 
|[[JModelAdmin::publish/11.1|publish]]
 
|Method to change the published state of one or more records.  
 
|Method to change the published state of one or more records.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::reorder/11.1|reorder]]
 
|[[JModelAdmin::reorder/11.1|reorder]]
 
|Method to adjust the ordering of a row.  
 
|Method to adjust the ordering of a row.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::save/11.1|save]]
 
|[[JModelAdmin::save/11.1|save]]
 
|Method to save the form data.  
 
|Method to save the form data.  
 
|-
 
|-
 +
|public
 
|[[JModelAdmin::saveorder/11.1|saveorder]]
 
|[[JModelAdmin::saveorder/11.1|saveorder]]
 
|Saves the manually set order of records.  
 
|Saves the manually set order of records.  
 
|-
 
|-
 +
|protected
 
|[[JModelAdmin::canDelete/11.1|canDelete]]
 
|[[JModelAdmin::canDelete/11.1|canDelete]]
 
|Method to test whether a record can be deleted.  
 
|Method to test whether a record can be deleted.  
 
|-
 
|-
 +
|protected
 
|[[JModelAdmin::canEditState/11.1|canEditState]]
 
|[[JModelAdmin::canEditState/11.1|canEditState]]
 
|Method to test whether a record can be deleted.  
 
|Method to test whether a record can be deleted.  
 
|-
 
|-
 +
|protected
 
|[[JModelAdmin::getReorderConditions/11.1|getReorderConditions]]
 
|[[JModelAdmin::getReorderConditions/11.1|getReorderConditions]]
 
|A protected method to get a set of ordering conditions.  
 
|A protected method to get a set of ordering conditions.  
 
|-
 
|-
 +
|protected
 
|[[JModelAdmin::populateState/11.1|populateState]]
 
|[[JModelAdmin::populateState/11.1|populateState]]
 
|Stock method to auto-populate the model state.  
 
|Stock method to auto-populate the model state.  
 
|-
 
|-
 +
|protected
 
|[[JModelAdmin::prepareTable/11.1|prepareTable]]
 
|[[JModelAdmin::prepareTable/11.1|prepareTable]]
 
|Prepare and sanitise the table data prior to saving.  
 
|Prepare and sanitise the table data prior to saving.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/application/component/modeladmin.php
 +
* '''Extends''' [[JModelForm/11.1|JModelForm]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.application.component.modeladmin' );</source>
 
<source lang="php">jimport( 'joomla.application.component.modeladmin' );</source>
 
===See also===
 
===See also===
* JModelAdmin source code in [[jplatform:application/component/modeladmin.php|BitBucket]]
+
* {{JVer|11.1}} '''JModelAdmin source code''' on [[jplatform:application/component/modeladmin.php|BitBucket]]
* [[JModelAdmin|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]]
 +
* [[JModelAdmin|Other versions of JModelAdmin]]
 
{{SeeAlso:JModelAdmin}}
 
{{SeeAlso:JModelAdmin}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JModelAdmin|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JModelAdmin|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 78: Line 90:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModelAdmin]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModelAdmin]]</noinclude>

Revision as of 17:06, 27 April 2011

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.

Joomla 11.1 JModelAdmin

Description

Description:JModelAdmin [Edit Descripton]

Methods

Visibility Method name Description
public __construct Constructor.
public checkin Method override to check-in a record or an array of record.
public checkout Method override to check-out a record.
public delete Method to delete one or more records.
public getItem Method to get a single record.
public publish Method to change the published state of one or more records.
public reorder Method to adjust the ordering of a row.
public save Method to save the form data.
public saveorder Saves the manually set order of records.
protected canDelete Method to test whether a record can be deleted.
protected canEditState Method to test whether a record can be deleted.
protected getReorderConditions A protected method to get a set of ordering conditions.
protected populateState Stock method to auto-populate the model state.
protected prepareTable Prepare and sanitise the table data prior to saving.
  • Defined in libraries/joomla/application/component/modeladmin.php
  • Extends JModelForm

Importing

jimport( 'joomla.application.component.modeladmin' );

See also

SeeAlso:JModelAdmin [Edit See Also]

User contributed notes

<CodeExamplesForm />