438 lines
12 KiB
PHP
438 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of the Propel package.
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @license MIT License
|
|
*/
|
|
|
|
/**
|
|
* Adds a slug column
|
|
*
|
|
* @author Francois Zaninotto
|
|
* @author Massimiliano Arione
|
|
* @version $Revision$
|
|
* @package propel.generator.behavior.sluggable
|
|
*/
|
|
namespace Trinity\Component\Propel;
|
|
|
|
class CustomSluggableBehavior extends \Behavior
|
|
{
|
|
// default parameters value
|
|
protected $parameters = array(
|
|
'add_cleanup' => 'true',
|
|
'slug_column' => 'slug',
|
|
'slug_pattern' => '',
|
|
'replace_pattern' => '/\W+/', // Tip: use '/[^\\pL\\d]+/u' instead if you're in PHP5.3
|
|
'replacement' => '-',
|
|
'separator' => '-',
|
|
'permanent' => 'false',
|
|
'scope_column' => ''
|
|
);
|
|
|
|
/**
|
|
* Add the slug_column to the current table
|
|
*/
|
|
public function modifyTable()
|
|
{
|
|
if (!$this->getTable()->containsColumn($this->getParameter('slug_column'))) {
|
|
$this->getTable()->addColumn(array(
|
|
'name' => $this->getParameter('slug_column'),
|
|
'type' => 'VARCHAR',
|
|
'size' => 255
|
|
));
|
|
// add a unique to column
|
|
$unique = new \Unique($this->getColumnForParameter('slug_column'));
|
|
$unique->setName($this->getTable()->getCommonName() . '_slug');
|
|
$unique->addColumn($this->getTable()->getColumn($this->getParameter('slug_column')));
|
|
if ($this->getParameter('scope_column')) {
|
|
$unique->addColumn($this->getTable()->getColumn($this->getParameter('scope_column')));
|
|
}
|
|
$this->getTable()->addUnique($unique);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the getter of the column of the behavior
|
|
*
|
|
* @return string The related getter, e.g. 'getSlug'
|
|
*/
|
|
protected function getColumnGetter()
|
|
{
|
|
return 'get' . $this->getColumnForParameter('slug_column')->getPhpName();
|
|
}
|
|
|
|
/**
|
|
* Get the setter of the column of the behavior
|
|
*
|
|
* @return string The related setter, e.g. 'setSlug'
|
|
*/
|
|
protected function getColumnSetter()
|
|
{
|
|
return 'set' . $this->getColumnForParameter('slug_column')->getPhpName();
|
|
}
|
|
|
|
/**
|
|
* Add code in ObjectBuilder::preSave
|
|
*
|
|
* @return string The code to put at the hook
|
|
*/
|
|
public function preSave($builder)
|
|
{
|
|
$const = $builder->getColumnConstant($this->getColumnForParameter('slug_column'));
|
|
$pattern = $this->getParameter('slug_pattern');
|
|
$script = "
|
|
if (\$this->isColumnModified($const) && \$this->{$this->getColumnGetter()}()) {
|
|
\$this->{$this->getColumnSetter()}(\$this->makeSlugUnique(\$this->{$this->getColumnGetter()}()));";
|
|
|
|
if ($pattern && false === $this->booleanValue($this->getParameter('permanent'))) {
|
|
$script .= "
|
|
} elseif (";
|
|
$count = preg_match_all('/{([a-zA-Z]+)}/', $pattern, $matches, PREG_PATTERN_ORDER);
|
|
|
|
foreach ($matches[1] as $key => $match) {
|
|
|
|
$column = $this->getTable()->getColumn($this->underscore(ucfirst($match)));
|
|
if (empty($column)) {
|
|
throw new \InvalidArgumentException(sprintf('The pattern %s is invalid the column %s is not found', $pattern, $match));
|
|
}
|
|
$columnConst = $builder->getColumnConstant($column);
|
|
$script .= "\$this->isColumnModified($columnConst)" . ($key < $count - 1 ? " || " : "");
|
|
}
|
|
|
|
$script .= ") {
|
|
\$this->{$this->getColumnSetter()}(\$this->createSlug());";
|
|
}
|
|
|
|
if (empty($pattern) && false === $this->booleanValue($this->getParameter('permanent'))) {
|
|
$script .= "
|
|
} else {
|
|
\$this->{$this->getColumnSetter()}(\$this->createSlug());
|
|
}";
|
|
} else {
|
|
$script .= "
|
|
} elseif (!\$this->{$this->getColumnGetter()}()) {
|
|
\$this->{$this->getColumnSetter()}(\$this->createSlug());
|
|
}";
|
|
}
|
|
|
|
return $script;
|
|
}
|
|
|
|
public function objectMethods($builder)
|
|
{
|
|
$this->builder = $builder;
|
|
$script = '';
|
|
if ('slug' != $this->getParameter('slug_column')) {
|
|
$this->addSlugSetter($script);
|
|
$this->addSlugGetter($script);
|
|
}
|
|
$this->addCreateSlug($script);
|
|
$this->addCreateRawSlug($script);
|
|
if ($this->booleanValue($this->getParameter('add_cleanup'))) {
|
|
$this->addCleanupSlugPart($script);
|
|
}
|
|
$this->addLimitSlugSize($script);
|
|
$this->addMakeSlugUnique($script);
|
|
|
|
return $script;
|
|
}
|
|
|
|
protected function addSlugSetter(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Wrap the setter for slug value
|
|
*
|
|
* @param string
|
|
* @return " . $this->getTable()->getPhpName() . "
|
|
*/
|
|
public function setSlug(\$v)
|
|
{
|
|
return \$this->" . $this->getColumnSetter() . "(\$v);
|
|
}
|
|
";
|
|
}
|
|
|
|
protected function addSlugGetter(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Wrap the getter for slug value
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSlug()
|
|
{
|
|
return \$this->" . $this->getColumnGetter() . "();
|
|
}
|
|
";
|
|
}
|
|
|
|
protected function addCreateSlug(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Create a unique slug based on the object
|
|
*
|
|
* @return string The object slug
|
|
*/
|
|
protected function createSlug()
|
|
{
|
|
\$slug = \$this->createRawSlug();
|
|
\$slug = \$this->limitSlugSize(\$slug);
|
|
\$slug = \$this->makeSlugUnique(\$slug);
|
|
|
|
return \$slug;
|
|
}
|
|
";
|
|
}
|
|
|
|
protected function addCreateRawSlug(&$script)
|
|
{
|
|
$pattern = $this->getParameter('slug_pattern');
|
|
$script .= "
|
|
/**
|
|
* Create the slug from the appropriate columns
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function createRawSlug()
|
|
{
|
|
";
|
|
if ($pattern) {
|
|
$script .= "return '" . str_replace(array('{', '}'), array('\' . $this->cleanupSlugPart($this->get', '()) . \''), $pattern). "';";
|
|
} else {
|
|
$script .= "return \$this->cleanupSlugPart(\$this->__toString());";
|
|
}
|
|
$script .= "
|
|
}
|
|
";
|
|
|
|
return $script;
|
|
}
|
|
|
|
public function addCleanupSlugPart(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Cleanup a string to make a slug of it
|
|
* Removes special characters, replaces blanks with a separator, and trim it
|
|
*
|
|
* @param string \$slug the text to slugify
|
|
* @param string \$replacement the separator used by slug
|
|
* @return string the slugified text
|
|
*/
|
|
protected static function cleanupSlugPart(\$slug, \$replacement = '" . $this->getParameter('replacement') . "')
|
|
{
|
|
// change accent
|
|
\$slug = strtr(
|
|
utf8_decode(\$slug),
|
|
utf8_decode('ÀÁÂÃÄÅàáâãäåÒÓÔÕÖØòóôõöøÈÉÊËèéêëÇçÌÍÎÏìíîïÙÚÛÜùúûüÿÑñ'),
|
|
utf8_decode('aaaaaaaaaaaaooooooooooooeeeeeeeecciiiiiiiiuuuuuuuuynn')
|
|
);
|
|
|
|
|
|
if (function_exists('iconv')) {
|
|
\$slug = iconv('utf-8', 'us-ascii//TRANSLIT', \$slug);
|
|
}
|
|
|
|
if (function_exists('mb_strtolower')) {
|
|
\$slug = mb_strtolower(\$slug);
|
|
} else {
|
|
\$slug = strtolower(\$slug);
|
|
}
|
|
|
|
// replace non letter or digits with separator
|
|
\$slug = preg_replace_callback(
|
|
'" . $this->getParameter('replace_pattern') . "',
|
|
function (\$m) use (\$replacement) {
|
|
return \$replacement;
|
|
},
|
|
utf8_encode(\$slug)
|
|
);
|
|
|
|
\$slug = preg_replace_callback(
|
|
'#'.preg_quote(\$replacement).'{2,}#',
|
|
function (\$m) use (\$replacement) {
|
|
return \$replacement;
|
|
},
|
|
utf8_encode(\$slug)
|
|
);
|
|
|
|
\$slug = trim(\$slug, \$replacement);
|
|
|
|
return !empty(\$slug) ? \$slug : 'n-a';
|
|
}
|
|
";
|
|
}
|
|
|
|
public function addLimitSlugSize(&$script)
|
|
{
|
|
$size = $this->getColumnForParameter('slug_column')->getSize();
|
|
$script .= "
|
|
|
|
/**
|
|
* Make sure the slug is short enough to accomodate the column size
|
|
*
|
|
* @param string \$slug the slug to check
|
|
* @param int \$incrementReservedSpace the number of characters to keep empty
|
|
*
|
|
* @return string the truncated slug
|
|
*/
|
|
protected static function limitSlugSize(\$slug, \$incrementReservedSpace = 3)
|
|
{
|
|
// check length, as suffix could put it over maximum
|
|
if (strlen(\$slug) > ($size - \$incrementReservedSpace)) {
|
|
\$slug = substr(\$slug, 0, $size - \$incrementReservedSpace);
|
|
}
|
|
|
|
return \$slug;
|
|
}
|
|
";
|
|
}
|
|
|
|
public function addMakeSlugUnique(&$script)
|
|
{
|
|
$script .= "
|
|
|
|
/**
|
|
* Get the slug, ensuring its uniqueness
|
|
*
|
|
* @param string \$slug the slug to check
|
|
* @param string \$separator the separator used by slug
|
|
* @param int \$alreadyExists false for the first try, true for the second, and take the high count + 1
|
|
* @return string the unique slug
|
|
*/
|
|
protected function makeSlugUnique(\$slug, \$separator = '" . $this->getParameter('separator') ."', \$alreadyExists = false)
|
|
{";
|
|
$getter = $this->getColumnGetter();
|
|
$script .= "
|
|
if (!\$alreadyExists) {
|
|
\$slug2 = \$slug;
|
|
} else {
|
|
\$slug2 = \$slug . \$separator;";
|
|
|
|
if (null === $this->getParameter('slug_pattern')) {
|
|
$script .= "
|
|
|
|
\$count = " . $this->builder->getStubQueryBuilder()->getClassname() . "::create()
|
|
->filterBySlug(\$this->$getter())
|
|
->filterByPrimaryKey(\$this->getPrimaryKey())
|
|
->count();
|
|
|
|
if (1 === \$count) {
|
|
return \$this->$getter();
|
|
}";
|
|
}
|
|
|
|
$script .= "
|
|
}
|
|
|
|
\$query = " . $this->builder->getStubQueryBuilder()->getClassname() . "::create('q')
|
|
->where('q." . $this->getColumnForParameter('slug_column')->getPhpName() . " ' . (\$alreadyExists ? 'REGEXP' : '=') . ' ?', \$alreadyExists ? '^' . \$slug2 . '[0-9]+$' : \$slug2)
|
|
->prune(\$this)";
|
|
|
|
if ($this->getParameter('scope_column')) {
|
|
$getter = 'get' . $this->getColumnForParameter('scope_column')->getPhpName();
|
|
$script .="
|
|
->filterBy('{$this->getColumnForParameter('scope_column')->getPhpName()}', \$this->{$getter}())";
|
|
}
|
|
// watch out: some of the columns may be hidden by the soft_delete behavior
|
|
if ($this->table->hasBehavior('soft_delete')) {
|
|
$script .= "
|
|
->includeDeleted()";
|
|
}
|
|
$script .= "
|
|
;
|
|
|
|
if (!\$alreadyExists) {
|
|
\$count = \$query->count();
|
|
if (\$count > 0) {
|
|
return \$this->makeSlugUnique(\$slug, \$separator, true);
|
|
}
|
|
|
|
return \$slug2;
|
|
}
|
|
|
|
// Already exists
|
|
\$object = \$query
|
|
->addDescendingOrderByColumn('LENGTH(" . $this->getColumnForParameter('slug_column')->getName() . ")')
|
|
->addDescendingOrderByColumn('" . $this->getColumnForParameter('slug_column')->getName() . "')
|
|
->findOne();
|
|
|
|
// First duplicate slug
|
|
if (null === \$object) {
|
|
return \$slug2 . '1';
|
|
}
|
|
|
|
\$slugNum = substr(\$object->" . $getter . "(), strlen(\$slug) + 1);
|
|
if (0 === \$slugNum[0]) {
|
|
\$slugNum[0] = 1;
|
|
}
|
|
|
|
return \$slug2 . (\$slugNum + 1);
|
|
}
|
|
";
|
|
}
|
|
|
|
public function queryMethods($builder)
|
|
{
|
|
$this->builder = $builder;
|
|
$script = '';
|
|
if ($this->getParameter('slug_column') != 'slug') {
|
|
$this->addFilterBySlug($script);
|
|
}
|
|
$this->addFindOneBySlug($script);
|
|
|
|
return $script;
|
|
}
|
|
|
|
protected function addFilterBySlug(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Filter the query on the slug column
|
|
*
|
|
* @param string \$slug The value to use as filter.
|
|
*
|
|
* @return " . $this->builder->getStubQueryBuilder()->getClassname() . " The current query, for fluid interface
|
|
*/
|
|
public function filterBySlug(\$slug)
|
|
{
|
|
return \$this->addUsingAlias(" . $this->builder->getColumnConstant($this->getColumnForParameter('slug_column')) . ", \$slug, Criteria::EQUAL);
|
|
}
|
|
";
|
|
}
|
|
|
|
protected function addFindOneBySlug(&$script)
|
|
{
|
|
$script .= "
|
|
/**
|
|
* Find one object based on its slug
|
|
*
|
|
* @param string \$slug The value to use as filter.
|
|
* @param PropelPDO \$con The optional connection object
|
|
*
|
|
* @return " . $this->builder->getStubObjectBuilder()->getClassname() . " the result, formatted by the current formatter
|
|
*/
|
|
public function findOneBySlug(\$slug, \$con = null)
|
|
{
|
|
return \$this->filterBySlug(\$slug)->findOne(\$con);
|
|
}
|
|
";
|
|
}
|
|
|
|
/**
|
|
* @param string $string
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function underscore($string)
|
|
{
|
|
return strtolower(preg_replace(array('/([A-Z]+)([A-Z][a-z])/', '/([a-z\d])([A-Z])/'), array('\\1_\\2', '\\1_\\2'), strtr($string, '_', '.')));
|
|
}
|
|
}
|