RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2024-12-13 22:56:04 +03:00
Code Issues Projects Releases Wiki Activity

CHG: Doctrine coding standards adjustments

Browse Source 
ADD: Added methods: addMaskReplacement, removeMaskReplacement and cleanMaskReplacements in Doctrine_Pager_Layout. They are responsable to make masks behavior as another masks or values on predefined situations.
This commit is contained in:
guilhermeblanco 2007-12-13 03:07:24 +00:00
parent 1446447107
commit a95073abff
5 changed files with 141 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
lib/Doctrine/Pager.php
View File

@ -71,43 +71,43 @@ class Doctrine_Pager
*/
public function __construct($query, $page, $maxPerPage = 0)
{
$this->setQuery($query);
$this->_setQuery($query);
$this->_setMaxPerPage($maxPerPage);
$this->_setPage($page);
$this->initialize();
$this->_initialize();
}
/**
* initialize
* _initialize
*
* Initialize Pager object calculating number of results
*
* @return void
*/
protected function initialize()
protected function _initialize()
{
// retrieve the number of items found
$count = $this->getQuery()->count();
$this->setNumResults($count);
$this->_setNumResults($count);
$this->adjustOffset();
$this->_adjustOffset();
}
/**
* adjustOffset
* _adjustOffset
*
* Adjusts last page of Doctrine_Pager, offset and limit of Doctrine_Query associated
*
* @return void
*/
protected function adjustOffset()
protected function _adjustOffset()
{
// Define new total of pages
$this->setLastPage(
$this->_setLastPage(
max(1, ceil($this->getNumResults() / $this->getMaxPerPage()))
);
$offset = ($this->getPage() - 1) * $this->getMaxPerPage();
@ -133,14 +133,14 @@ class Doctrine_Pager
/**
* setNumResults
* _setNumResults
*
* Defines the number of total results on initial query
*
* @param $nb Number of results found on initial query fetch
* @return void
*/
protected function setNumResults($nb)
protected function _setNumResults($nb)
{
$this->_numResults = $nb;
}
@ -173,14 +173,14 @@ class Doctrine_Pager
/**
* setLastPage
* _setLastPage
*
* Defines the last page (total of pages)
*
* @param $page last page (total of pages)
* @return void
*/
protected function setLastPage($page)
protected function _setLastPage($page)
{
$this->_lastPage = $page;
@ -253,7 +253,7 @@ class Doctrine_Pager
public function setPage($page)
{
$this->_setPage($page);
$this->adjustOffset();
$this->_adjustOffset();
}
@ -296,7 +296,7 @@ class Doctrine_Pager
public function setMaxPerPage($max)
{
$this->_setMaxPerPage($max);
$this->adjustOffset();
$this->_adjustOffset();
}
@ -334,7 +334,7 @@ class Doctrine_Pager
/**
* setQuery
* _setQuery
*
* Defines the maximum number of itens per page
*
@ -342,7 +342,7 @@ class Doctrine_Pager
* (which does the Doctrine_Query class creation).
* @return void
*/
protected function setQuery($query)
protected function _setQuery($query)
{
if (is_string($query)) {
$query = Doctrine_Query::create()->parseQuery($query);

139
lib/Doctrine/Pager/Layout.php
View File

@ -66,6 +66,12 @@ class Doctrine_Pager_Layout
*/
private $_urlMask;
/**
* @var array $_maskReplacements Stores references of masks and their correspondent
* (replaces defined masks with new masks or values)
*/
private $_maskReplacements = array();
/**
* __construct
@ -77,14 +83,13 @@ class Doctrine_Pager_Layout
*/
public function __construct($pager, $pagerRange, $urlMask)
{
$this->setPager($pager);
$this->setPagerRange($pagerRange);
$this->_setPager($pager);
$this->_setPagerRange($pagerRange);
$this->_setUrlMask($urlMask);
$this->setTemplate('');
$this->setSelectedTemplate('');
$this->setSeparatorTemplate('');
$this->setUrlMask($urlMask);
}
@ -102,14 +107,14 @@ class Doctrine_Pager_Layout
/**
* setPager
* _setPager
*
* Defines the Doctrine_Pager object related to the pager layout
*
* @param $pager Doctrine_Pager object related to the pager range
* @return void
*/
protected function setPager($pager)
protected function _setPager($pager)
{
$this->_pager = $pager;
}
@ -129,14 +134,14 @@ class Doctrine_Pager_Layout
/**
* setPagerRange
* _setPagerRange
*
* Defines the Doctrine_Pager_Range subclass object related to the pager layout
*
* @param $pagerRange Doctrine_Pager_Range subclass object related to the pager range
* @return void
*/
protected function setPagerRange($pagerRange)
protected function _setPagerRange($pagerRange)
{
$this->_pagerRange = $pagerRange;
$this->getPagerRange()->setPager($this->getPager());
@ -157,14 +162,14 @@ class Doctrine_Pager_Layout
/**
* setUrlMask
* _setUrlMask
*
* Defines the URL to be assigned for each page
*
* @param $urlMask URL to be assigned for each page
* @return void
*/
protected function setUrlMask($urlMask)
protected function _setUrlMask($urlMask)
{
$this->_urlMask = $urlMask;
}
@ -252,6 +257,59 @@ class Doctrine_Pager_Layout
}
/**
* addMaskReplacement
*
* Defines a mask replacement. When parsing template, it converts replacement
* masks into new ones (or values), allowing to change masks behavior on the fly
*
* @param $oldMask Mask to be replaced
* @param $newMask Mask or Value that will be defined after replacement
* @param $asValue Optional value (default false) that if defined as true,
* changes the bahavior of replacement mask to replacement
* value
* @return void
*/
public function addMaskReplacement($oldMask, $newMask, $asValue = false)
{
$this->_maskReplacements[$oldMask] = array(
'newMask' => $newMask,
'asValue' => ($asValue === false) ? false : true
);
}
/**
* removeMaskReplacement
*
* Remove a mask replacement
*
* @param $oldMask Replacement Mask to be removed
* @return void
*/
public function removeMaskReplacement($oldMask)
{
if (isset($this->_maskReplacements[$oldMask])) {
$this->_maskReplacements[$oldMask] = null;
unset($this->_maskReplacements[$oldMask]);
}
}
/**
* cleanMaskReplacements
*
* Remove all mask replacements
*
* @return void
*/
public function cleanMaskReplacements()
{
$this->_maskReplacements = null;
$this->_maskReplacements = array();
}
/**
* display
*
@ -272,10 +330,11 @@ class Doctrine_Pager_Layout
// For each page in range
for ($i = 0, $l = count($range); $i < $l; $i++) {
// Define some optional mask values
$options['page'] = $range[$i];
$options['url'] = $this->parseUrl($options);
$options['page_number'] = $range[$i];
$options['page'] = $range[$i]; // Handy assignment for URLs
$options['url'] = $this->_parseUrl($options);
$str .= $this->parseTemplate($options);
$str .= $this->_parseTemplate($options);
// Apply separator between pages
if ($i < $l - 1) {
@ -293,60 +352,74 @@ class Doctrine_Pager_Layout
/**
* parseTemplate
* _parseTemplate
*
* Process the template of a given page and return the processed template
*
* @param $options Optional parameters to be applied in template and url mask
* @return string
*/
protected function parseTemplate($options = array())
protected function _parseTemplate($options = array())
{
$str = '';
if (isset($options['page']) && $options['page'] == $this->getPager()->getPage()) {
$str = $this->getSelectedTemplate();
if (isset($options['page_number']) && $options['page_number'] == $this->getPager()->getPage()) {
$str = $this->_parseMaskReplacements($this->getSelectedTemplate());
}
// Possible attempt where Selected == Template
if ($str == '') {
$str = $this->getTemplate();
$str = $this->_parseMaskReplacements($this->getTemplate());
}
$keys = array();
$values = array();
$replacements = array();
foreach ($options as $k => $v) {
$keys[] = '{%'.$k.'}';
$values[] = $v;
$replacements['{%'.$k.'}'] = $v;
}
return str_replace($keys, $values, $str);
return strtr($str, $replacements);
}
/**
* parseUrl
* _parseUrl
*
* Process the url mask of a given page and return the processed url
*
* @param $options Optional parameters to be applied in template and url mask
* @return string
*/
protected function parseUrl($options = array())
protected function _parseUrl($options = array())
{
$str = $this->getUrlMask();
$str = $this->_parseMaskReplacements($this->getUrlMask());
$keys = array();
$values = array();
$replacements = array();
foreach ($options as $k => $v) {
$keys[] = '{%'.$k.'}';
$values[] = $v;
$replacements['{%'.$k.'}'] = $v;
}
return str_replace($keys, $values, $str);
return strtr($str, $replacements);
}
/**
* _parseMaskReplacements
*
* Process the mask replacements, changing from to-be replaced mask with new masks/values
*
* @param $str String to have masks replaced
* @return string
*/
protected function _parseMaskReplacements($str)
{
$replacements = array();
foreach ($this->_maskReplacements as $k => $v) {
$replacements['{%'.$k.'}'] = ($v['asValue'] === true) ? $v['newMask'] : '{%'.$v['newMask'].'}';
}
return strtr($str, $replacements);
}
}
?>

12
lib/Doctrine/Pager/Range.php
View File

@ -54,7 +54,7 @@ abstract class Doctrine_Pager_Range
*/
final public function __construct($options = array(), $pager = null)
{
$this->setOptions($options);
$this->_setOptions($options);
if ($pager !== null) {
$this->setPager($pager);
@ -91,7 +91,7 @@ abstract class Doctrine_Pager_Range
// Lazy-load initialization. It only should be called when all
// needed information data is ready (this can only happens when we have
// options stored and a Doctrine_Pager assocated)
$this->initialize();
$this->_initialize();
}
@ -109,27 +109,27 @@ abstract class Doctrine_Pager_Range
/**
* setOptions
* _setOptions
*
* Defines the subclass implementation options
*
* @param $options Custom Doctrine_Pager_Range implementation options
* @return void
*/
protected function setOptions($options)
protected function _setOptions($options)
{
$this->options = $options;
}
/**
* initialize
* _initialize
*
* Initialize Doctrine_Page_Range subclass which does custom class definitions
*
* @return void
*/
abstract protected function initialize();
abstract protected function _initialize();
/**

10
lib/Doctrine/Pager/Range/Jumping.php
View File

@ -42,16 +42,16 @@ class Doctrine_Pager_Range_Jumping extends Doctrine_Pager_Range
/**
* initialize
* _initialize
*
* Initialize Doctrine_Pager_Range_Jumping and does custom assignments
*
* @return void
*/
protected function initialize()
protected function _initialize()
{
if (isset($this->options['chunk'])) {
$this->setChunkLength($this->options['chunk']);
$this->_setChunkLength($this->options['chunk']);
} else {
throw new Doctrine_Pager_Exception('Missing parameter \'chunk\' that must be define in options.');
}
@ -72,14 +72,14 @@ class Doctrine_Pager_Range_Jumping extends Doctrine_Pager_Range
/**
* setChunkLength
* _setChunkLength
*
* Defines the size of the chunk
*
* @param $chunkLength Chunk length
* @return void
*/
protected function setChunkLength($chunkLength)
protected function _setChunkLength($chunkLength)
{
$this->chunkLength = $chunkLength;
}

10
lib/Doctrine/Pager/Range/Sliding.php
View File

@ -42,16 +42,16 @@ class Doctrine_Pager_Range_Sliding extends Doctrine_Pager_Range
/**
* initialize
* _initialize
*
* Initialize Doctrine_Pager_Range_Sliding and does custom assignments
*
* @return void
*/
protected function initialize()
protected function _initialize()
{
if (isset($this->options['chunk'])) {
$this->setChunkLength($this->options['chunk']);
$this->_setChunkLength($this->options['chunk']);
} else {
throw new Doctrine_Pager_Exception('Missing parameter \'chunk\' that must be define in options.');
}
@ -72,14 +72,14 @@ class Doctrine_Pager_Range_Sliding extends Doctrine_Pager_Range
/**
* setChunkLength
* _setChunkLength
*
* Defines the size of the chunk
*
* @param $chunkLength Chunk length
* @return void
*/
protected function setChunkLength($chunkLength)
protected function _setChunkLength($chunkLength)
{
$this->chunkLength = $chunkLength;
}