| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id$
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information, see
|
|
|
19 |
* <http://www.doctrine-project.org>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Doctrine_Template_SoftDelete
|
|
|
24 |
*
|
|
|
25 |
* @package Doctrine
|
|
|
26 |
* @subpackage Template
|
|
|
27 |
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
|
28 |
* @link www.doctrine-project.org
|
|
|
29 |
* @since 1.0
|
|
|
30 |
* @version $Revision$
|
|
|
31 |
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
|
32 |
* @author Jonathan H. Wage <jonwage@gmail.com>
|
|
|
33 |
*/
|
|
|
34 |
class Doctrine_Template_SoftDelete extends Doctrine_Template
|
|
|
35 |
{
|
|
|
36 |
/**
|
|
|
37 |
* Array of SoftDelete options
|
|
|
38 |
*
|
|
|
39 |
* @var string
|
|
|
40 |
*/
|
|
|
41 |
protected $_options = array(
|
|
|
42 |
'name' => 'deleted_at',
|
|
|
43 |
'type' => 'timestamp',
|
|
|
44 |
'length' => null,
|
|
|
45 |
'options' => array(
|
|
|
46 |
'notnull' => false
|
|
|
47 |
),
|
|
|
48 |
'hardDelete' => false
|
|
|
49 |
);
|
|
|
50 |
|
|
|
51 |
protected $_listener;
|
|
|
52 |
|
|
|
53 |
/**
|
|
|
54 |
* Set table definition for SoftDelete behavior
|
|
|
55 |
*
|
|
|
56 |
* @return void
|
|
|
57 |
*/
|
|
|
58 |
public function setTableDefinition()
|
|
|
59 |
{
|
|
|
60 |
// BC to 1.0.X of SoftDelete behavior
|
|
|
61 |
if ($this->_options['type'] == 'boolean') {
|
|
|
62 |
$this->_options['length'] = 1;
|
|
|
63 |
$this->_options['options'] = array('default' => false, 'notnull' => true);
|
|
|
64 |
}
|
|
|
65 |
|
|
|
66 |
$this->hasColumn($this->_options['name'], $this->_options['type'], $this->_options['length'], $this->_options['options']);
|
|
|
67 |
|
|
|
68 |
$this->_listener = new Doctrine_Template_Listener_SoftDelete($this->_options);
|
|
|
69 |
$this->addListener($this->_listener);
|
|
|
70 |
}
|
|
|
71 |
|
|
|
72 |
/**
|
|
|
73 |
* Add a hardDelete() method to any of the models who act as SoftDelete behavior
|
|
|
74 |
*
|
|
|
75 |
* @param Doctrine_Connection $conn
|
|
|
76 |
* @return integer $result Number of affected rows.
|
|
|
77 |
*/
|
|
|
78 |
public function hardDelete($conn = null)
|
|
|
79 |
{
|
|
|
80 |
if ($conn === null) {
|
|
|
81 |
$conn = $this->_table->getConnection();
|
|
|
82 |
}
|
|
|
83 |
$this->_listener->hardDelete(true);
|
|
|
84 |
$result = $this->_invoker->delete();
|
|
|
85 |
$this->_listener->hardDelete(false);
|
|
|
86 |
return $result;
|
|
|
87 |
}
|
|
|
88 |
}
|