PHP Class BaseActiveRecordVersionedSoftDelete

(C) Moorfields Eye Hospital NHS Foundation Trust, 2008-2011 (C) OpenEyes Foundation, 2011-2013 This file is part of OpenEyes. OpenEyes is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. OpenEyes is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenEyes in a file titled COPYING. If not, see .
Author: OpenEyes ([email protected])
Inheritance: extends BaseActiveRecordVersioned
Show file Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property Type Description
$deletedField

Public Methods

Method Description
active ( )
activeOrPk ( $id )
delete ( )
deleteAll ( $condition = '', $params = [] )
deleteAllByAttributes ( $attributes, $condition = '', $params = [] )
deleteByPk ( $pk, $condition = '', $params = [] )
notDeleted ( ) * Returns items that are not deleted
notDeletedOrPk ( $id ) * Returns items that are not deleted (or inactive/discontinue/whatever makes sense for the current model) but includes $id even if deleted $id can also be an array of ids

Method Details

active() public method

public active ( )

activeOrPk() public method

public activeOrPk ( $id )

delete() public method

public delete ( )

deleteAll() public method

public deleteAll ( $condition = '', $params = [] )

deleteAllByAttributes() public method

public deleteAllByAttributes ( $attributes, $condition = '', $params = [] )

deleteByPk() public method

public deleteByPk ( $pk, $condition = '', $params = [] )

notDeleted() public method

* Returns items that are not deleted
public notDeleted ( )

notDeletedOrPk() public method

* Returns items that are not deleted (or inactive/discontinue/whatever makes sense for the current model) but includes $id even if deleted $id can also be an array of ids
public notDeletedOrPk ( $id )

Property Details

$deletedField public property

public $deletedField