PageRenderTime 50ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/app/models/behaviors/sluggable.php

https://bitbucket.org/webpolis/liiv
PHP | 397 lines | 323 code | 22 blank | 52 comment | 35 complexity | 0f7eae7d3961e20a989a01d6f7dec04e MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1
  1. <?php
  2. class SluggableBehavior extends ModelBehavior {
  3. /**
  4. * Translation table
  5. *
  6. * @var array
  7. */
  8. public $translations = array();
  9. /**
  10. * Constructor
  11. */
  12. public function __construct() {
  13. parent::__construct();
  14. if (empty($this->translations)) {
  15. $this->translations = array(
  16. 'iso-8859-1' => array(
  17. chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
  18. .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
  19. .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
  20. .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
  21. .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
  22. .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
  23. .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
  24. .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
  25. .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
  26. .chr(252).chr(253).chr(255),
  27. 'EfSZsz' . 'YcYuAAA' . 'AAACEEE' . 'EIIIINO' . 'OOOOOUU' . 'UUYaaaa' . 'aaceeee' . 'iiiinoo' . 'oooouuu' . 'uyy',
  28. array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254)),
  29. array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th')
  30. ),
  31. 'utf-8' => array(
  32. array(
  33. // Decompositions for Latin-1 Supplement
  34. chr(195).chr(128) => 'A', chr(195).chr(129) => 'A',
  35. chr(195).chr(130) => 'A', chr(195).chr(131) => 'A',
  36. chr(195).chr(132) => 'A', chr(195).chr(133) => 'A',
  37. chr(195).chr(135) => 'C', chr(195).chr(136) => 'E',
  38. chr(195).chr(137) => 'E', chr(195).chr(138) => 'E',
  39. chr(195).chr(139) => 'E', chr(195).chr(140) => 'I',
  40. chr(195).chr(141) => 'I', chr(195).chr(142) => 'I',
  41. chr(195).chr(143) => 'I', chr(195).chr(145) => 'N',
  42. chr(195).chr(146) => 'O', chr(195).chr(147) => 'O',
  43. chr(195).chr(148) => 'O', chr(195).chr(149) => 'O',
  44. chr(195).chr(150) => 'O', chr(195).chr(153) => 'U',
  45. chr(195).chr(154) => 'U', chr(195).chr(155) => 'U',
  46. chr(195).chr(156) => 'U', chr(195).chr(157) => 'Y',
  47. chr(195).chr(159) => 's', chr(195).chr(160) => 'a',
  48. chr(195).chr(161) => 'a', chr(195).chr(162) => 'a',
  49. chr(195).chr(163) => 'a', chr(195).chr(164) => 'a',
  50. chr(195).chr(165) => 'a', chr(195).chr(167) => 'c',
  51. chr(195).chr(168) => 'e', chr(195).chr(169) => 'e',
  52. chr(195).chr(170) => 'e', chr(195).chr(171) => 'e',
  53. chr(195).chr(172) => 'i', chr(195).chr(173) => 'i',
  54. chr(195).chr(174) => 'i', chr(195).chr(175) => 'i',
  55. chr(195).chr(177) => 'n', chr(195).chr(178) => 'o',
  56. chr(195).chr(179) => 'o', chr(195).chr(180) => 'o',
  57. chr(195).chr(181) => 'o', chr(195).chr(182) => 'o',
  58. chr(195).chr(182) => 'o', chr(195).chr(185) => 'u',
  59. chr(195).chr(186) => 'u', chr(195).chr(187) => 'u',
  60. chr(195).chr(188) => 'u', chr(195).chr(189) => 'y',
  61. chr(195).chr(191) => 'y',
  62. // Decompositions for Latin Extended-A
  63. chr(196).chr(128) => 'A', chr(196).chr(129) => 'a',
  64. chr(196).chr(130) => 'A', chr(196).chr(131) => 'a',
  65. chr(196).chr(132) => 'A', chr(196).chr(133) => 'a',
  66. chr(196).chr(134) => 'C', chr(196).chr(135) => 'c',
  67. chr(196).chr(136) => 'C', chr(196).chr(137) => 'c',
  68. chr(196).chr(138) => 'C', chr(196).chr(139) => 'c',
  69. chr(196).chr(140) => 'C', chr(196).chr(141) => 'c',
  70. chr(196).chr(142) => 'D', chr(196).chr(143) => 'd',
  71. chr(196).chr(144) => 'D', chr(196).chr(145) => 'd',
  72. chr(196).chr(146) => 'E', chr(196).chr(147) => 'e',
  73. chr(196).chr(148) => 'E', chr(196).chr(149) => 'e',
  74. chr(196).chr(150) => 'E', chr(196).chr(151) => 'e',
  75. chr(196).chr(152) => 'E', chr(196).chr(153) => 'e',
  76. chr(196).chr(154) => 'E', chr(196).chr(155) => 'e',
  77. chr(196).chr(156) => 'G', chr(196).chr(157) => 'g',
  78. chr(196).chr(158) => 'G', chr(196).chr(159) => 'g',
  79. chr(196).chr(160) => 'G', chr(196).chr(161) => 'g',
  80. chr(196).chr(162) => 'G', chr(196).chr(163) => 'g',
  81. chr(196).chr(164) => 'H', chr(196).chr(165) => 'h',
  82. chr(196).chr(166) => 'H', chr(196).chr(167) => 'h',
  83. chr(196).chr(168) => 'I', chr(196).chr(169) => 'i',
  84. chr(196).chr(170) => 'I', chr(196).chr(171) => 'i',
  85. chr(196).chr(172) => 'I', chr(196).chr(173) => 'i',
  86. chr(196).chr(174) => 'I', chr(196).chr(175) => 'i',
  87. chr(196).chr(176) => 'I', chr(196).chr(177) => 'i',
  88. chr(196).chr(178) => 'IJ',chr(196).chr(179) => 'ij',
  89. chr(196).chr(180) => 'J', chr(196).chr(181) => 'j',
  90. chr(196).chr(182) => 'K', chr(196).chr(183) => 'k',
  91. chr(196).chr(184) => 'k', chr(196).chr(185) => 'L',
  92. chr(196).chr(186) => 'l', chr(196).chr(187) => 'L',
  93. chr(196).chr(188) => 'l', chr(196).chr(189) => 'L',
  94. chr(196).chr(190) => 'l', chr(196).chr(191) => 'L',
  95. chr(197).chr(128) => 'l', chr(197).chr(129) => 'L',
  96. chr(197).chr(130) => 'l', chr(197).chr(131) => 'N',
  97. chr(197).chr(132) => 'n', chr(197).chr(133) => 'N',
  98. chr(197).chr(134) => 'n', chr(197).chr(135) => 'N',
  99. chr(197).chr(136) => 'n', chr(197).chr(137) => 'N',
  100. chr(197).chr(138) => 'n', chr(197).chr(139) => 'N',
  101. chr(197).chr(140) => 'O', chr(197).chr(141) => 'o',
  102. chr(197).chr(142) => 'O', chr(197).chr(143) => 'o',
  103. chr(197).chr(144) => 'O', chr(197).chr(145) => 'o',
  104. chr(197).chr(146) => 'OE',chr(197).chr(147) => 'oe',
  105. chr(197).chr(148) => 'R',chr(197).chr(149) => 'r',
  106. chr(197).chr(150) => 'R',chr(197).chr(151) => 'r',
  107. chr(197).chr(152) => 'R',chr(197).chr(153) => 'r',
  108. chr(197).chr(154) => 'S',chr(197).chr(155) => 's',
  109. chr(197).chr(156) => 'S',chr(197).chr(157) => 's',
  110. chr(197).chr(158) => 'S',chr(197).chr(159) => 's',
  111. chr(197).chr(160) => 'S', chr(197).chr(161) => 's',
  112. chr(197).chr(162) => 'T', chr(197).chr(163) => 't',
  113. chr(197).chr(164) => 'T', chr(197).chr(165) => 't',
  114. chr(197).chr(166) => 'T', chr(197).chr(167) => 't',
  115. chr(197).chr(168) => 'U', chr(197).chr(169) => 'u',
  116. chr(197).chr(170) => 'U', chr(197).chr(171) => 'u',
  117. chr(197).chr(172) => 'U', chr(197).chr(173) => 'u',
  118. chr(197).chr(174) => 'U', chr(197).chr(175) => 'u',
  119. chr(197).chr(176) => 'U', chr(197).chr(177) => 'u',
  120. chr(197).chr(178) => 'U', chr(197).chr(179) => 'u',
  121. chr(197).chr(180) => 'W', chr(197).chr(181) => 'w',
  122. chr(197).chr(182) => 'Y', chr(197).chr(183) => 'y',
  123. chr(197).chr(184) => 'Y', chr(197).chr(185) => 'Z',
  124. chr(197).chr(186) => 'z', chr(197).chr(187) => 'Z',
  125. chr(197).chr(188) => 'z', chr(197).chr(189) => 'Z',
  126. chr(197).chr(190) => 'z', chr(197).chr(191) => 's',
  127. // Russian symbols (ISO 9-95)
  128. chr(208).chr(129) => 'YO',
  129. chr(208).chr(132) => 'E',
  130. chr(208).chr(134) => 'I',
  131. chr(208).chr(135) => 'YI',
  132. chr(208).chr(144) => 'A',
  133. chr(208).chr(145) => 'B',
  134. chr(208).chr(146) => 'V',
  135. chr(208).chr(147) => 'G',
  136. chr(208).chr(148) => 'D',
  137. chr(208).chr(149) => 'E',
  138. chr(208).chr(150) => 'ZH',
  139. chr(208).chr(151) => 'Z',
  140. chr(208).chr(152) => 'I',
  141. chr(208).chr(153) => 'Y',
  142. chr(208).chr(154) => 'K',
  143. chr(208).chr(155) => 'L',
  144. chr(208).chr(156) => 'M',
  145. chr(208).chr(157) => 'N',
  146. chr(208).chr(158) => 'O',
  147. chr(208).chr(159) => 'P',
  148. chr(208).chr(160) => 'R',
  149. chr(208).chr(161) => 'S',
  150. chr(208).chr(162) => 'T',
  151. chr(208).chr(163) => 'U',
  152. chr(208).chr(164) => 'F',
  153. chr(208).chr(165) => 'H',
  154. chr(208).chr(166) => 'TS',
  155. chr(208).chr(167) => 'CH',
  156. chr(208).chr(168) => 'SH',
  157. chr(208).chr(169) => 'SCH',
  158. chr(208).chr(171) => 'YI',
  159. chr(208).chr(173) => 'E',
  160. chr(208).chr(174) => 'YU',
  161. chr(208).chr(175) => 'YA',
  162. chr(208).chr(176) => 'a',
  163. chr(208).chr(177) => 'b',
  164. chr(208).chr(178) => 'v',
  165. chr(208).chr(179) => 'g',
  166. chr(208).chr(180) => 'd',
  167. chr(208).chr(181) => 'e',
  168. chr(208).chr(182) => 'zh',
  169. chr(208).chr(183) => 'z',
  170. chr(208).chr(184) => 'i',
  171. chr(208).chr(185) => 'y',
  172. chr(208).chr(186) => 'k',
  173. chr(208).chr(187) => 'l',
  174. chr(208).chr(188) => 'm',
  175. chr(208).chr(189) => 'n',
  176. chr(208).chr(190) => 'o',
  177. chr(208).chr(191) => 'p',
  178. chr(209).chr(128) => 'r',
  179. chr(209).chr(129) => 's',
  180. chr(209).chr(130) => 't',
  181. chr(209).chr(131) => 'u',
  182. chr(209).chr(132) => 'f',
  183. chr(209).chr(133) => 'h',
  184. chr(209).chr(134) => 'ts',
  185. chr(209).chr(135) => 'ch',
  186. chr(209).chr(136) => 'sh',
  187. chr(209).chr(137) => 'sch',
  188. chr(209).chr(139) => 'yi',
  189. chr(209).chr(141) => 'e',
  190. chr(209).chr(142) => 'yu',
  191. chr(209).chr(143) => 'ya',
  192. chr(209).chr(145) => 'yo',
  193. chr(209).chr(148) => 'e',
  194. chr(209).chr(150) => 'i',
  195. chr(209).chr(151) => 'yi',
  196. chr(210).chr(144) => 'G',
  197. chr(210).chr(145) => 'g',
  198. // Euro Sign
  199. chr(226).chr(130).chr(172) => 'E'
  200. )
  201. )
  202. );
  203. }
  204. }
  205. /**
  206. * Initiate behavior for the model using specified settings. Available settings:
  207. *
  208. * - label: (array | string, optional) set to the field name that contains the
  209. * string from where to generate the slug, or a set of field names to
  210. * concatenate for generating the slug. DEFAULTS TO: title
  211. *
  212. * - real: (boolean, optional) if set to true then field names defined in
  213. * label must exist in the database table. DEFAULTS TO: true
  214. *
  215. * - slug: (string, optional) name of the field name that holds generated slugs.
  216. * DEFAULTS TO: slug
  217. *
  218. * - separator: (string, optional) separator character / string to use for replacing
  219. * non alphabetic characters in generated slug. DEFAULTS TO: -
  220. *
  221. * - length: (integer, optional) maximum length the generated slug can have.
  222. * DEFAULTS TO: 100
  223. *
  224. * - overwrite: (boolean, optional) set to true if slugs should be re-generated when
  225. * updating an existing record. DEFAULTS TO: false
  226. *
  227. * - ignore: (array, optional) array of words that should not be part of a slug.
  228. *
  229. * @param object $model Model using the behaviour
  230. * @param array $settings Settings to override for model.
  231. */
  232. public function setup($model, $settings = array()) {
  233. $default = array(
  234. 'real' => true,
  235. 'label' => array('title'),
  236. 'slug' => 'slug',
  237. 'separator' => '-',
  238. 'length' => 100,
  239. 'overwrite' => false,
  240. 'translation' => null,
  241. 'ignore' => array(
  242. 'and', 'for', 'is', 'of', 'the'
  243. )
  244. );
  245. if (!isset($this->settings[$model->alias])) {
  246. $configured = Configure::read('Sluggable');
  247. if (!empty($configured)) {
  248. if (!empty($configured['translations'])) {
  249. $this->translations = Set::merge($this->translations, $configured['translations']);
  250. unset($configured['translations']);
  251. }
  252. foreach($default as $key => $value) {
  253. if (isset($configured[$key])) {
  254. $default[$key] = $configured[$key];
  255. }
  256. }
  257. }
  258. $this->settings[$model->alias] = $default;
  259. }
  260. $this->settings[$model->alias] = array_merge($this->settings[$model->alias], $settings);
  261. }
  262. /**
  263. * Run before a model is saved, used to set up slug for model.
  264. *
  265. * @param object $model Model about to be saved.
  266. * @return boolean true if save should proceed, false otherwise
  267. */
  268. public function beforeSave($model) {
  269. $return = parent::beforeSave($model);
  270. $settings = $this->settings[$model->alias];
  271. $fields = (array) $settings['label'];
  272. if ($settings['real']) {
  273. foreach($fields as $field) {
  274. if (!$model->hasField($field)) {
  275. return $return;
  276. }
  277. }
  278. }
  279. if ((!$settings['real'] || $model->hasField($settings['slug'])) && ($settings['overwrite'] || empty($model->id))) {
  280. $label = '';
  281. foreach($fields as $field) {
  282. if (!empty($model->data[$model->alias][$field])) {
  283. $label .= (!empty($label) ? ' ' : '') . $model->data[$model->alias][$field];
  284. }
  285. }
  286. if (!empty($label)) {
  287. $slug = $this->_slug($label, $settings);
  288. $conditions = array($model->alias . '.' . $settings['slug'] => $slug);
  289. if (!empty($model->id)) {
  290. $conditions['not'] = array($model->alias . '.' . $model->primaryKey => $model->id);
  291. }
  292. $result = $model->find('all', array(
  293. 'conditions' => $conditions,
  294. 'fields' => array($model->primaryKey, $settings['slug']),
  295. 'recursive' => -1
  296. ));
  297. $sameUrls = null;
  298. if (!empty($result)) {
  299. $sameUrls = Set::extract($result, '/' . $model->alias . '/' . $settings['slug']);
  300. }
  301. if (!empty($sameUrls)) {
  302. $begginingSlug = $slug;
  303. $index = 1;
  304. do {
  305. $currentSlug = $begginingSlug . $settings['separator'] . $index++;
  306. if (!in_array($currentSlug, $sameUrls)) {
  307. $slug = $currentSlug;
  308. break;
  309. }
  310. } while(true);
  311. }
  312. $model->data[$model->alias][$settings['slug']] = $slug;
  313. $this->_addToWhitelist($model, $settings['slug']);
  314. }
  315. }
  316. return $return;
  317. }
  318. /**
  319. * Generate a slug for the given string using specified settings.
  320. *
  321. * @param string $string String from where to generate slug
  322. * @param array $settings Settings to use (looks for 'separator' and 'length')
  323. * @return string Slug for given string
  324. */
  325. protected function _slug($string, $settings) {
  326. if (!empty($settings['ignore'])) {
  327. $words = array();
  328. foreach((array) $settings['ignore'] as $word) {
  329. $words[] = preg_quote($word);
  330. }
  331. $newString = preg_replace('/\b(\s*)(' . implode('|', $words) . ')(\s*)\b/i', '\\1\\3', $string);
  332. if (!empty($newString)) {
  333. $string = $newString;
  334. }
  335. }
  336. if (!empty($settings['translation']) && is_array($settings['translation'])) {
  337. if (count($settings['translation']) >= 2 && count($settings['translation']) % 2 == 0) {
  338. for($i=0, $limiti=count($settings['translation']); $i < $limiti; $i += 2) {
  339. $from = $settings['translation'][$i];
  340. $to = $settings['translation'][$i + 1];
  341. if (is_string($from) && is_string($to)) {
  342. $string = strtr($string, $from, $to);
  343. } else {
  344. $string = str_replace($from, $to, $string);
  345. }
  346. }
  347. } else if (count($settings['translation']) == 1) {
  348. $string = strtr($string, $settings['translation'][0]);
  349. }
  350. $string = strtolower($string);
  351. } else if (
  352. !empty($settings['translation']) && is_string($settings['translation']) &&
  353. in_array(strtolower($settings['translation']), array_keys($this->translations))
  354. ) {
  355. return $this->_slug(
  356. $string,
  357. array_merge($settings, array('translation' => $this->translations[$settings['translation']]))
  358. );
  359. }
  360. $string = strtolower($string);
  361. $string = preg_replace('/[^a-z0-9_]/i', $settings['separator'], $string);
  362. $string = preg_replace(
  363. '/' . preg_quote($settings['separator']) . '[' . preg_quote($settings['separator']) . ']*/',
  364. $settings['separator'],
  365. $string
  366. );
  367. if (strlen($string) > $settings['length']) {
  368. $string = substr($string, 0, $settings['length']);
  369. }
  370. $string = preg_replace('/' . preg_quote($settings['separator']) . '$/', '', $string);
  371. $string = preg_replace('/^' . preg_quote($settings['separator']) . '/', '', $string);
  372. return $string;
  373. }
  374. }
  375. ?>