TYPO3 CMS  TYPO3_6-2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord:
Tx_Workspaces_Domain_Model_DatabaseRecord

Public Member Functions

 __construct ($table, $uid, array $row=NULL)
 
 getTable ()
 
 setTable ($table)
 
 getUid ()
 
 setUid ($uid)
 
 getRow ()
 
 setRow (array $row)
 
 getIdentifier ()
 

Static Public Member Functions

static create ($table, $uid)
 
static createFromArray ($table, array $row)
 

Protected Member Functions

 loadRow ()
 

Protected Attributes

 $table
 
 $uid
 
 $row
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Database record class

Author
Oliver Hader olive.nosp@m.r.ha.nosp@m.der@t.nosp@m.ypo3.nosp@m..org

Definition at line 21 of file DatabaseRecord.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::__construct (   $table,
  $uid,
array  $row = NULL 
)
Parameters
string$tableName of the database table
integer$uidId of the datbase record row
array | NULL$rowThe relevant database record row

Definition at line 65 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$row, TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$table, TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$uid, TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setRow(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setTable(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setUid().

Member Function Documentation

◆ create()

static TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::create (   $table,
  $uid 
)
static

Creates database record object just by id of database record.

Parameters
string$tableName of the database table
integer$uidId of the datbase record row
Returns

Definition at line 45 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$table, and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$uid.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord\create().

◆ createFromArray()

static TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::createFromArray (   $table,
array  $row 
)
static

Creates datbase record object by relevant database record row.

Parameters
string$tableName of the database table
array$rowThe relevant database record row
Returns

Definition at line 56 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$table.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\CombinedRecord\createFromArrays().

◆ getIdentifier()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::getIdentifier ( )

Gets the record identifier (table:id).

Returns
string

Definition at line 136 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getTable(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getUid().

◆ getRow()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::getRow ( )

Gets the database record row.

Returns
array

Definition at line 116 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$row, and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\loadRow().

◆ getTable()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::getTable ( )

Gets the name of the database table.

Returns
string

Definition at line 78 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$table.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getIdentifier(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\loadRow().

◆ getUid()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::getUid ( )

Gets the id of the database record row.

Returns
integer

Definition at line 97 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$uid.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getIdentifier(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\loadRow().

◆ loadRow()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::loadRow ( )
protected

Loads the database record row (if not available yet).

Returns
void

Definition at line 145 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getTable(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getUid().

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getRow().

◆ setRow()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::setRow ( array  $row)

Sets the database record row.

Parameters
array$row
Returns
void

Definition at line 127 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$row.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct().

◆ setTable()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::setTable (   $table)

Sets the name of the database table.

Parameters
string$table
Returns
void

Definition at line 88 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$table.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct().

◆ setUid()

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::setUid (   $uid)

Sets the id of the database record row.

Parameters
integer$uid
Returns
void

Definition at line 107 of file DatabaseRecord.php.

References TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\$uid.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct().

Member Data Documentation

◆ $row

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::$row
protected

Definition at line 36 of file DatabaseRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getRow(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setRow().

◆ $table

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::$table
protected

Definition at line 26 of file DatabaseRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\create(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\createFromArray(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getTable(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setTable().

◆ $uid

TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord::$uid
protected

Definition at line 31 of file DatabaseRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\__construct(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\create(), TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\getUid(), and TYPO3\CMS\Workspaces\Domain\Model\DatabaseRecord\setUid().