| 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.phpdoctrine.org>. |
| 20 | */ |
| 21 | |
| 22 | /** |
| 23 | * Doctrine_Template_Sluggable |
| 24 | * |
| 25 | * Easily create a slug for each record based on a specified set of fields |
| 26 | * |
| 27 | * @package Doctrine |
| 28 | * @subpackage Template |
| 29 | * @license http://www.opensource.org/licenses/lgpl-license.php LGPL |
| 30 | * @link www.phpdoctrine.org |
| 31 | * @since 1.0 |
| 32 | * @version $Revision$ |
| 33 | * @author Konsta Vesterinen <kvesteri@cc.hut.fi> |
| 34 | */ |
| 35 | class Doctrine_Template_Sluggable extends Doctrine_Template |
| 36 | { |
| 37 | /** |
| 38 | * Array of timestampable options |
| 39 | * |
| 40 | * @var string |
| 41 | */ |
| 42 | protected $_options = array('name' => 'slug', |
| 43 | 'type' => 'string', |
| 44 | 'length' => 255, |
| 45 | 'unique' => true, |
| 46 | 'options' => array(), |
| 47 | 'fields' => array(), |
| 48 | 'uniqueBy' => array(), |
| 49 | 'uniqueIndex'=> true |
| 50 | ); |
| 51 | |
| 52 | /** |
| 53 | * __construct |
| 54 | * |
| 55 | * @param string $array |
| 56 | * @return void |
| 57 | */ |
| 58 | public function __construct(array $options) |
| 59 | { |
| 60 | $this->_options = Doctrine_Lib::arrayDeepMerge($this->_options, $options); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * setTableDefinition |
| 65 | * |
| 66 | * @return void |
| 67 | */ |
| 68 | public function setTableDefinition() |
| 69 | { |
| 70 | $this->hasColumn($this->_options['name'], $this->_options['type'], $this->_options['length'], $this->_options['options']); |
| 71 | |
| 72 | if ($this->_options['unique'] == true && $this->_options['uniqueIndex'] == true && ! empty($this->_options['fields'])) { |
| 73 | $indexFields = array($this->_options['name']); |
| 74 | $indexFields = array_merge($indexFields, $this->_options['uniqueBy']); |
| 75 | $this->index('sluggable', array('fields' => $indexFields, |
| 76 | 'type' => 'unique')); |
| 77 | } |
| 78 | |
| 79 | $this->addListener(new Doctrine_Template_Listener_Sluggable($this->_options)); |
| 80 | } |
| 81 | } |