PageRenderTime 27ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/Core/Libs/Model/Behavior/SluggableBehavior.php

http://github.com/infinitas/infinitas
PHP | 342 lines | 243 code | 39 blank | 60 comment | 36 complexity | b9af836eb4052519bbebecf01931fe3d MD5 | raw file
    

  1. <?php
    2. 

  2. 	/**
    3. 

  3. 	 * Sluggable Behavior class file.
    4. 

  4. 	 *
    5. 

  5. 	 * @filesource
    6. 

  6. 	 * @author Mariano Iglesias
    7. 

  7. 	 * @link http://cake-syrup.sourceforge.net/ingredients/sluggable-behavior/
    8. 

  8. 	 * @version $Revision: 36 $
    9. 

  9. 	 * @license http://www.opensource.org/licenses/mit-license.php The MIT License
    10. 

  10. 	 * @package Infinitas.Libs.Model.Behavior
    11. 

  11. 	 */
    12. 

  12. 

  13. 	/**
    14. 

  14. 	 * Model behavior to support generation of slugs for models.
    15. 

  15. 	 *
    16. 

  16. 	 * @package Infinitas.Libs.Model.Behavior
    17. 

  17. 	 */
    18. 

  18. 	class SluggableBehavior extends ModelBehavior {
    19. 

  19. 

  20. 		/**
    21. 

  21. 		 * Contain settings indexed by model name.
    22. 

  22. 		 *
    23. 

  23. 		 * @var array
    24. 

  24. 		 */
    25. 

  25. 		private $__settings = array();
    26. 

  26. 

  27. 		/**
    28. 

  28. 		 * Initiate behavior for the model using specified settings. Available settings:
    29. 

  29. 		 *
    30. 

  30. 		 * - label: 	(array | string, optional) set to the field name that contains the
    31. 

  31. 		 * 				string from where to generate the slug, or a set of field names to
    32. 

  32. 		 * 				concatenate for generating the slug. DEFAULTS TO: title
    33. 

  33. 		 *
    34. 

  34. 		 * - slug:		(string, optional) name of the field name that holds generated slugs.
    35. 

  35. 		 * 				DEFAULTS TO: slug
    36. 

  36. 		 *
    37. 

  37. 		 * - separator:	(string, optional) separator character / string to use for replacing
    38. 

  38. 		 * 				non alphabetic characters in generated slug. DEFAULTS TO: -
    39. 

  39. 		 *
    40. 

  40. 		 * - length:	(integer, optional) maximum length the generated slug can have.
    41. 

  41. 		 * 				DEFAULTS TO: 100
    42. 

  42. 		 *
    43. 

  43. 		 * - overwrite: (boolean, optional) set to true if slugs should be re-generated when
    44. 

  44. 		 * 				updating an existing record. DEFAULTS TO: false
    45. 

  45. 		 *
    46. 

  46. 		 * @param object $Model Model using the behaviour
    47. 

  47. 		 * @param array $settings Settings to override for model.
    48. 

  48. 		 */
    49. 

  49. 		public function setup(Model $Model, $settings = array()) {
    50. 

  50. 			$default = array('label' => array('name'), 'slug' => 'slug', 'separator' => '-', 'overwrite' => false, 'translation' => null);
    51. 

  51. 

  52. 			if (!isset($this->__settings[$Model->alias])) {
    53. 

  53. 				$this->__settings[$Model->alias] = $default;
    54. 

  54. 			}
    55. 

  55. 

  56. 			$this->__settings[$Model->alias] = array_merge($this->__settings[$Model->alias], $settings);
    57. 

  57. 

  58. 			$field = $Model->schema($this->__settings[$Model->alias]['slug']);
    59. 

  59. 			$this->__settings[$Model->alias]['length'] = $field['length'];
    60. 

  60. 

  61. 			if (!is_array($this->__settings[$Model->alias]['label'])) {
    62. 

  62. 				$this->__settings[$Model->alias]['label'] = array($this->__settings[$Model->alias]['label']);
    63. 

  63. 			}
    64. 

  64. 

  65. 			foreach ($this->__settings[$Model->alias]['label'] as $k => $field) {
    66. 

  66. 				if (!$Model->hasField($field)) {
    67. 

  67. 					unset($this->__settings[$Model->alias]['label'][$k]);
    68. 

  68. 				}
    69. 

  69. 

  70. 				if ($field == $this->__settings[$Model->alias]['slug']) {
    71. 

  71. 					throw new Exception(sprintf('Model "%s" can not slug its slug field "%s"', $Model->alias, $this->__settings[$Model->alias]['slug']));
    72. 

  72. 				}
    73. 

  73. 			}
    74. 

  74. 

  75. 			if (empty($this->__settings[$Model->alias]['label'])) {
    76. 

  76. 				throw new Exception(sprintf('Model "%s" has no sluggable fields', $Model->alias));
    77. 

  77. 			}
    78. 

  78. 

  79. 			if ($Model->_schema[$Model->displayField]['length'] > $Model->_schema[$this->__settings[$Model->alias]['slug']]['length']) {
    80. 

  80. 				throw new Exception(sprintf(__d('libs', '%s slugs will be truncated, slug field too short'), $Model->alias));
    81. 

  81. 			}
    82. 

  82. 		}
    83. 

  83. 

  84. 		/**
    85. 

  85. 		 * Run before a model is saved, used to set up slug for model.
    86. 

  86. 		 *
    87. 

  87. 		 * @param object $Model Model about to be saved.
    88. 

  88. 		 *
    89. 

  89. 		 * @return boolean
    90. 

  90. 		 */
    91. 

  91. 		public function beforeSave(Model $Model) {
    92. 

  92. 			$return = parent::beforeSave($Model);
    93. 

  93. 

  94. 			$isBlank = false;
    95. 

  95. 			if (isset($Model->data[$Model->alias][$this->__settings[$Model->alias]['slug']]) && empty($Model->data[$Model->alias][$this->__settings[$Model->alias]['slug']])) {
    96. 

  96. 				$isBlank = true;
    97. 

  97. 			}
    98. 

  98. 

  99. 			$shouldSlug = $Model->hasField($this->__settings[$Model->alias]['slug']) && (
    100. 

  100. 				$isBlank ||
    101. 

  101. 				$this->__settings[$Model->alias]['overwrite'] ||
    102. 

  102. 				empty($Model->id)
    103. 

  103. 			);
    104. 

  104. 

  105. 			if (!$shouldSlug) {
    106. 

  106. 				return $return;
    107. 

  107. 			}
    108. 

  108. 

  109. 			$label = '';
    110. 

  110. 			foreach ($this->__settings[$Model->alias]['label'] as $field) {
    111. 

  111. 				if (!empty($Model->data[$Model->alias][$field])) {
    112. 

  112. 					$label .= !empty($label) ? ' ' : '' . $Model->data[$Model->alias][$field];
    113. 

  113. 				}
    114. 

  114. 			}
    115. 

  115. 

  116. 			if (empty($label)) {
    117. 

  117. 				return $return;
    118. 

  118. 			}
    119. 

  119. 

  120. 			$slug = $this->__slug($label, $this->__settings[$Model->alias]);
    121. 

  121. 			$conditions = array(
    122. 

  122. 				sprintf('%s.%s LIKE', $Model->alias, $this->__settings[$Model->alias]['slug']) => $slug . '%'
    123. 

  123. 			);
    124. 

  124. 

  125. 			if (!empty($Model->id)) {
    126. 

  126. 				$conditions[$Model->alias . '.' . $Model->primaryKey] = '!= ' . $Model->id;
    127. 

  127. 			}
    128. 

  128. 

  129. 			$result = $Model->find(
    130. 

  130. 				'all',
    131. 

  131. 				array(
    132. 

  132. 					'conditions' => $conditions,
    133. 

  133. 					'fields' => array(
    134. 

  134. 						$Model->primaryKey,
    135. 

  135. 						$this->__settings[$Model->alias]['slug']
    136. 

  136. 					),
    137. 

  137. 					'recursive' => - 1
    138. 

  138. 				)
    139. 

  139. 			);
    140. 

  140. 

  141. 			$sameUrls = null;
    142. 

  142. 

  143. 			if (!empty($result)) {
    144. 

  144. 				$sameUrls = Set::extract($result, '{n}.' . $Model->alias . '.' . $this->__settings[$Model->alias]['slug']);
    145. 

  145. 			}
    146. 

  146. 

  147. 			if (!empty($sameUrls)) {
    148. 

  148. 				$begginingSlug = $slug;
    149. 

  149. 				$index = 1;
    150. 

  150. 				while ($index > 0) {
    151. 

  151. 					if (!in_array($begginingSlug . $this->__settings[$Model->alias]['separator'] . $index, $sameUrls)) {
    152. 

  152. 						$slug = $begginingSlug . $this->__settings[$Model->alias]['separator'] . $index;
    153. 

  153. 						$index = - 1;
    154. 

  154. 					}
    155. 

  155. 

  156. 					$index++;
    157. 

  157. 				}
    158. 

  158. 			}
    159. 

  159. 

  160. 			if (!empty($Model->whitelist) && !in_array($this->__settings[$Model->alias]['slug'], $Model->whitelist)) {
    161. 

  161. 				$Model->whitelist[] = $this->__settings[$Model->alias]['slug'];
    162. 

  162. 			}
    163. 

  163. 

  164. 			$Model->data[$Model->alias][$this->__settings[$Model->alias]['slug']] = $slug;
    165. 

  165. 

  166. 			return $return;
    167. 

  167. 		}
    168. 

  168. 

  169. 		/**
    170. 

  170. 		 * Generate a slug for the given string using specified settings.
    171. 

  171. 		 *
    172. 

  172. 		 * @param string $string String from where to generate slug
    173. 

  173. 		 * @param array $settings Settings to use (looks for 'separator' and 'length')
    174. 

  174. 		 *
    175. 

  175. 		 * @return string
    176. 

  176. 		 */
    177. 

  177. 		public function __slug($string, $settings) {
    178. 

  178. 			if (!empty($settings['translation']) && is_array($settings['translation'])) {
    179. 

  179. 				if (count($settings['translation']) >= 2 && count($settings['translation']) % 2 == 0) {
    180. 

  180. 					for ($i = 0, $limiti = count($settings['translation']); $i < $limiti; $i += 2) {
    181. 

  181. 						$from = $settings['translation'][$i];
    182. 

  182. 						$to = $settings['translation'][$i + 1];
    183. 

  183. 

  184. 						if (is_string($from) && is_string($to)) {
    185. 

  185. 							$string = strtr($string, $from, $to);
    186. 

  186. 						}
    187. 

  187. 

  188. 						else {
    189. 

  189. 							$string = str_replace($from, $to, $string);
    190. 

  190. 						}
    191. 

  191. 					}
    192. 

  192. 				}
    193. 

  193. 

  194. 				else if (count($settings['translation']) == 1) {
    195. 

  195. 					$string = strtr($string, $settings['translation'][0]);
    196. 

  196. 				}
    197. 

  197. 

  198. 				$string = strtolower($string);
    199. 

  199. 			}
    200. 

  200. 

  201. 			else if (!empty($settings['translation']) && is_string($settings['translation']) &&
    202. 

  202. 				in_array(strtolower($settings['translation']), array('utf-8', 'iso-8859-1'))) {
    203. 

  203. 				$translations = array(
    204. 

  204. 					'iso-8859-1' => array(
    205. 

  205. 						chr(128) . chr(131) . chr(138) . chr(142) . chr(154) . chr(158)
    206. 

  206. 						. chr(159) . chr(162) . chr(165) . chr(181) . chr(192) . chr(193) . chr(194)
    207. 

  207. 						. chr(195) . chr(196) . chr(197) . chr(199) . chr(200) . chr(201) . chr(202)
    208. 

  208. 						. chr(203) . chr(204) . chr(205) . chr(206) . chr(207) . chr(209) . chr(210)
    209. 

  209. 						. chr(211) . chr(212) . chr(213) . chr(214) . chr(216) . chr(217) . chr(218)
    210. 

  210. 						. chr(219) . chr(220) . chr(221) . chr(224) . chr(225) . chr(226) . chr(227)
    211. 

  211. 						. chr(228) . chr(229) . chr(231) . chr(232) . chr(233) . chr(234) . chr(235)
    212. 

  212. 						. chr(236) . chr(237) . chr(238) . chr(239) . chr(241) . chr(242) . chr(243)
    213. 

  213. 						. chr(244) . chr(245) . chr(246) . chr(248) . chr(249) . chr(250) . chr(251)
    214. 

  214. 						. chr(252) . chr(253) . chr(255),
    215. 

  215. 						'EfSZsz' . 'YcYuAAA' . 'AAACEEE' . 'EIIIINO' . 'OOOOOUU' . 'UUYaaaa' . 'aaceeee' . 'iiiinoo' . 'oooouuu' . 'uyy',
    216. 

  216. 						array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254)),
    217. 

  217. 						array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th')
    218. 

  218. 					),
    219. 

  219. 					'utf-8' => array(
    220. 

  220. 						array(
    221. 

  221. 							// Decompositions for Latin-1 Supplement
    222. 

  222. 							chr(195) . chr(128) => 'A', chr(195) . chr(129) => 'A',
    223. 

  223. 							chr(195) . chr(130) => 'A', chr(195) . chr(131) => 'A',
    224. 

  224. 							chr(195) . chr(132) => 'A', chr(195) . chr(133) => 'A',
    225. 

  225. 							chr(195) . chr(135) => 'C', chr(195) . chr(136) => 'E',
    226. 

  226. 							chr(195) . chr(137) => 'E', chr(195) . chr(138) => 'E',
    227. 

  227. 							chr(195) . chr(139) => 'E', chr(195) . chr(140) => 'I',
    228. 

  228. 							chr(195) . chr(141) => 'I', chr(195) . chr(142) => 'I',
    229. 

  229. 							chr(195) . chr(143) => 'I', chr(195) . chr(145) => 'N',
    230. 

  230. 							chr(195) . chr(146) => 'O', chr(195) . chr(147) => 'O',
    231. 

  231. 							chr(195) . chr(148) => 'O', chr(195) . chr(149) => 'O',
    232. 

  232. 							chr(195) . chr(150) => 'O', chr(195) . chr(153) => 'U',
    233. 

  233. 							chr(195) . chr(154) => 'U', chr(195) . chr(155) => 'U',
    234. 

  234. 							chr(195) . chr(156) => 'U', chr(195) . chr(157) => 'Y',
    235. 

  235. 							chr(195) . chr(159) => 's', chr(195) . chr(160) => 'a',
    236. 

  236. 							chr(195) . chr(161) => 'a', chr(195) . chr(162) => 'a',
    237. 

  237. 							chr(195) . chr(163) => 'a', chr(195) . chr(164) => 'a',
    238. 

  238. 							chr(195) . chr(165) => 'a', chr(195) . chr(167) => 'c',
    239. 

  239. 							chr(195) . chr(168) => 'e', chr(195) . chr(169) => 'e',
    240. 

  240. 							chr(195) . chr(170) => 'e', chr(195) . chr(171) => 'e',
    241. 

  241. 							chr(195) . chr(172) => 'i', chr(195) . chr(173) => 'i',
    242. 

  242. 							chr(195) . chr(174) => 'i', chr(195) . chr(175) => 'i',
    243. 

  243. 							chr(195) . chr(177) => 'n', chr(195) . chr(178) => 'o',
    244. 

  244. 							chr(195) . chr(179) => 'o', chr(195) . chr(180) => 'o',
    245. 

  245. 							chr(195) . chr(181) => 'o', chr(195) . chr(182) => 'o',
    246. 

  246. 							chr(195) . chr(182) => 'o', chr(195) . chr(185) => 'u',
    247. 

  247. 							chr(195) . chr(186) => 'u', chr(195) . chr(187) => 'u',
    248. 

  248. 							chr(195) . chr(188) => 'u', chr(195) . chr(189) => 'y',
    249. 

  249. 							chr(195) . chr(191) => 'y',
    250. 

  250. 							// Decompositions for Latin Extended-A
    251. 

  251. 							chr(196) . chr(128) => 'A', chr(196) . chr(129) => 'a',
    252. 

  252. 							chr(196) . chr(130) => 'A', chr(196) . chr(131) => 'a',
    253. 

  253. 							chr(196) . chr(132) => 'A', chr(196) . chr(133) => 'a',
    254. 

  254. 							chr(196) . chr(134) => 'C', chr(196) . chr(135) => 'c',
    255. 

  255. 							chr(196) . chr(136) => 'C', chr(196) . chr(137) => 'c',
    256. 

  256. 							chr(196) . chr(138) => 'C', chr(196) . chr(139) => 'c',
    257. 

  257. 							chr(196) . chr(140) => 'C', chr(196) . chr(141) => 'c',
    258. 

  258. 							chr(196) . chr(142) => 'D', chr(196) . chr(143) => 'd',
    259. 

  259. 							chr(196) . chr(144) => 'D', chr(196) . chr(145) => 'd',
    260. 

  260. 							chr(196) . chr(146) => 'E', chr(196) . chr(147) => 'e',
    261. 

  261. 							chr(196) . chr(148) => 'E', chr(196) . chr(149) => 'e',
    262. 

  262. 							chr(196) . chr(150) => 'E', chr(196) . chr(151) => 'e',
    263. 

  263. 							chr(196) . chr(152) => 'E', chr(196) . chr(153) => 'e',
    264. 

  264. 							chr(196) . chr(154) => 'E', chr(196) . chr(155) => 'e',
    265. 

  265. 							chr(196) . chr(156) => 'G', chr(196) . chr(157) => 'g',
    266. 

  266. 							chr(196) . chr(158) => 'G', chr(196) . chr(159) => 'g',
    267. 

  267. 							chr(196) . chr(160) => 'G', chr(196) . chr(161) => 'g',
    268. 

  268. 							chr(196) . chr(162) => 'G', chr(196) . chr(163) => 'g',
    269. 

  269. 							chr(196) . chr(164) => 'H', chr(196) . chr(165) => 'h',
    270. 

  270. 							chr(196) . chr(166) => 'H', chr(196) . chr(167) => 'h',
    271. 

  271. 							chr(196) . chr(168) => 'I', chr(196) . chr(169) => 'i',
    272. 

  272. 							chr(196) . chr(170) => 'I', chr(196) . chr(171) => 'i',
    273. 

  273. 							chr(196) . chr(172) => 'I', chr(196) . chr(173) => 'i',
    274. 

  274. 							chr(196) . chr(174) => 'I', chr(196) . chr(175) => 'i',
    275. 

  275. 							chr(196) . chr(176) => 'I', chr(196) . chr(177) => 'i',
    276. 

  276. 							chr(196) . chr(178) => 'IJ', chr(196) . chr(179) => 'ij',
    277. 

  277. 							chr(196) . chr(180) => 'J', chr(196) . chr(181) => 'j',
    278. 

  278. 							chr(196) . chr(182) => 'K', chr(196) . chr(183) => 'k',
    279. 

  279. 							chr(196) . chr(184) => 'k', chr(196) . chr(185) => 'L',
    280. 

  280. 							chr(196) . chr(186) => 'l', chr(196) . chr(187) => 'L',
    281. 

  281. 							chr(196) . chr(188) => 'l', chr(196) . chr(189) => 'L',
    282. 

  282. 							chr(196) . chr(190) => 'l', chr(196) . chr(191) => 'L',
    283. 

  283. 							chr(197) . chr(128) => 'l', chr(197) . chr(129) => 'L',
    284. 

  284. 							chr(197) . chr(130) => 'l', chr(197) . chr(131) => 'N',
    285. 

  285. 							chr(197) . chr(132) => 'n', chr(197) . chr(133) => 'N',
    286. 

  286. 							chr(197) . chr(134) => 'n', chr(197) . chr(135) => 'N',
    287. 

  287. 							chr(197) . chr(136) => 'n', chr(197) . chr(137) => 'N',
    288. 

  288. 							chr(197) . chr(138) => 'n', chr(197) . chr(139) => 'N',
    289. 

  289. 							chr(197) . chr(140) => 'O', chr(197) . chr(141) => 'o',
    290. 

  290. 							chr(197) . chr(142) => 'O', chr(197) . chr(143) => 'o',
    291. 

  291. 							chr(197) . chr(144) => 'O', chr(197) . chr(145) => 'o',
    292. 

  292. 							chr(197) . chr(146) => 'OE', chr(197) . chr(147) => 'oe',
    293. 

  293. 							chr(197) . chr(148) => 'R', chr(197) . chr(149) => 'r',
    294. 

  294. 							chr(197) . chr(150) => 'R', chr(197) . chr(151) => 'r',
    295. 

  295. 							chr(197) . chr(152) => 'R', chr(197) . chr(153) => 'r',
    296. 

  296. 							chr(197) . chr(154) => 'S', chr(197) . chr(155) => 's',
    297. 

  297. 							chr(197) . chr(156) => 'S', chr(197) . chr(157) => 's',
    298. 

  298. 							chr(197) . chr(158) => 'S', chr(197) . chr(159) => 's',
    299. 

  299. 							chr(197) . chr(160) => 'S', chr(197) . chr(161) => 's',
    300. 

  300. 							chr(197) . chr(162) => 'T', chr(197) . chr(163) => 't',
    301. 

  301. 							chr(197) . chr(164) => 'T', chr(197) . chr(165) => 't',
    302. 

  302. 							chr(197) . chr(166) => 'T', chr(197) . chr(167) => 't',
    303. 

  303. 							chr(197) . chr(168) => 'U', chr(197) . chr(169) => 'u',
    304. 

  304. 							chr(197) . chr(170) => 'U', chr(197) . chr(171) => 'u',
    305. 

  305. 							chr(197) . chr(172) => 'U', chr(197) . chr(173) => 'u',
    306. 

  306. 							chr(197) . chr(174) => 'U', chr(197) . chr(175) => 'u',
    307. 

  307. 							chr(197) . chr(176) => 'U', chr(197) . chr(177) => 'u',
    308. 

  308. 							chr(197) . chr(178) => 'U', chr(197) . chr(179) => 'u',
    309. 

  309. 							chr(197) . chr(180) => 'W', chr(197) . chr(181) => 'w',
    310. 

  310. 							chr(197) . chr(182) => 'Y', chr(197) . chr(183) => 'y',
    311. 

  311. 							chr(197) . chr(184) => 'Y', chr(197) . chr(185) => 'Z',
    312. 

  312. 							chr(197) . chr(186) => 'z', chr(197) . chr(187) => 'Z',
    313. 

  313. 							chr(197) . chr(188) => 'z', chr(197) . chr(189) => 'Z',
    314. 

  314. 							chr(197) . chr(190) => 'z', chr(197) . chr(191) => 's',
    315. 

  315. 							// Euro Sign
    316. 

  316. 							chr(226) . chr(130) . chr(172) => 'E'
    317. 

  317. 						)
    318. 

  318. 					)
    319. 

  319. 				);
    320. 

  320. 

  321. 				return $this->__slug($string, am($settings, array('translation' => $translations[$settings['translation']])));
    322. 

  322. 			}
    323. 

  323. 

  324. 			$string = strtolower($string);
    325. 

  325. 			$string = preg_replace('/[^a-z0-9_]/i', $settings['separator'], $string);
    326. 

  326. 			$string = preg_replace(
    327. 

  327. 				'/' . preg_quote($settings['separator']) . '[' . preg_quote($settings['separator']) . ']*/',
    328. 

  328. 				$settings['separator'],
    329. 

  329. 				$string
    330. 

  330. 			);
    331. 

  331. 

  332. 			if (strlen($string) > $settings['length']) {
    333. 

  333. 				$string = substr($string, 0, $settings['length']);
    334. 

  334. 			}
    335. 

  335. 

  336. 			$string = preg_replace('/' . preg_quote($settings['separator']) . '$/', '', $string);
    337. 

  337. 			$string = preg_replace('/^' . preg_quote($settings['separator']) . '/', '', $string);
    338. 

  338. 

  339. 			return $string;
    340. 

  340. 		}
    341. 

  341. 

  342. 	}
    343.