Changeset 19523

Timestamp:

06/24/09 22:18:06 (9 months ago)

Author:

rande

Message:

• datagrid refactoring
  

Files:

• plugins/swToolboxPlugin/sf1.2/trunk/lib/datagrid/swDatagrid.class.php (added)
• plugins/swToolboxPlugin/sf1.2/trunk/lib/datagrid/swDoctrineDatagrid.class.php (modified) (4 diffs)
• plugins/swToolboxPlugin/sf1.2/trunk/lib/datagrid/swModelDatagrid.class.php (added)

plugins/swToolboxPlugin/sf1.2/trunk/lib/datagrid/swDoctrineDatagrid.class.php

@@ -33 +33 @@
- * SVN : $Id$
- */
-fForm
+wModelDatagrid
-{
-  protected $pager;
-  protected $filters = array();
-  protected $schema_format_name = 'filters';
-  
-
-
-
+
+
-   * 
+   * @param $query
+   * @return query
-   */
-  public function __construct($params = array(), $options = array(), $CSRFSecret = null)
-  {
-    // validator options
-    $options['allow_extra_fields'] = isset($options['allow_extra_fields']) ? $options['allow_extra_fields'] : true;
-    $options['filter_extra_fields'] = isset($options['filter_extra_fields']) ? $options['filter_extra_fields'] : false;
-    $options['disabled_init'] = isset($options['disabled_init']) ? $options['disabled_init'] : false;
-    
-    parent::__construct(array(), $options, $CSRFSecret);
-
-    // init sort features
-    $params['sort_by'] = isset($params['sort_by']) ? $params['sort_by'] : null;
-    $params['sort_order'] = isset($params['sort_order']) ? $params['sort_order'] : null;
-   
-    // init values
-    $defaults = $this->prepareDefaultValues($params);
-    $this->setDefaults($defaults);
-    $this->setStoredValues($defaults);
-
-    if(!$options['disabled_init'])
-    {
-      $this->init();
-    }
-    
-  }
-
-  /**
-   * 
-   * add a new filter field into the datagrid
-   * 
-   * @param string $name name of the field
-   * @param mixed $default_value 
-   * @param sfFormWidget $widget
-   * @param sfValidatorBase $validator
-   * @param string $label
-   * 
-   */
-  public function addFilter($name, $default_value, $widget, $validator, $label = null)
-  {
-    
-    $this->filters[$name] = $default_value;
-    $this->widgetSchema[$name] = $widget;
-    $this->validatorSchema[$name] = $validator;
-    
-    if($label)
-    {
-      $this->widgetSchema->setLabel($name, $label);
-    }
-  }
-  
-  
-  /**
-   * 
-   * @param $field
-   * @return boolean true if the sortable field exists
-   */
-  public function hasSortableField($field)
-  {
-    
-    return array_key_exists($field, $this->getSortableFields());
-  }
-  
-  /**
-   * 
-   * @return array of sortable field
-   */
-  public function getSortableFields()
-  {
-    $fields = array();
-    
-    foreach ($this->widgetSchema->getFields() as $name => $widget)
-    {
-      if(in_array($name, array('sort_by', 'sort_order')))
-      {
-        
-        continue;
-      }
-      
-      $fields[$name] = $widget->getLabel() ? $widget->getLabel() : $name; 
-    }
-    
-    return $fields;
-  }
-  
-  /**
-   * 
-   * Get the url for the current sort field
-   * 
-   * @param $url
-   * @param $sort_by
-   * @param $sort_order
-   * @return unknown_type
-   */
-  public function getSortUrl($url, $sort_by, $sort_order = null)
-  {
-
-    if(!$this->hasSortableField($sort_by))
-    {
-      
-      return $text;
-    }
-    
-    if(is_null($sort_order))
-    {
-      $sort_order = $this->getValue('sort_by') == $sort_by ? ($this->getValue('sort_order') == 'ASC' ? 'ASC' : 'DESC') : 'DESC';
-    }
-    
-    $url .= '?' . $this->getQueryString(array(
-      'sort_by'    => $sort_by,
-      'sort_order' => $sort_order
-    ));
-    
-    return url_for($url);
-  }
-  
-  /**
-   * 
-   * get the link for the current sort field
-   * 
-   * @param $text
-   * @param $url
-   * @param $sort_by
-   * @param $sort_order
-   * @param $options
-   * @return unknown_type
-   */
-  public function getSortLink($text, $url, $sort_by, $sort_order = null, $options = array())
-  {
-    if(!$this->hasSortableField($sort_by))
-    {
-      
-      return $text;
-    }
-    
-    if(is_null($sort_order))
-    {
-      $sort_order = $this->getValue('sort_by') == $sort_by ? ($this->getValue('sort_order') == 'ASC' ? 'DESC' : 'ASC') : 'DESC';
-    }
-    
-    $url .= '?' . $this->getQueryString(array(
-      'sort_by'    => $sort_by,
-      'sort_order' => $sort_order 
-    ));
-     
-    return link_to($text, $url , $options);
-  }
-  
-  /**
-   * 
-   * @see vendor/symfony/lib/form/sfForm#setup()
-   */
-  public function setup()
-  {
-    // format the datagrid
-    $this->widgetSchema->addFormFormatter('swSchemaFormatterDatagrid', new swSchemaFormatterDatagrid($this->widgetSchema));
-    $this->widgetSchema->setFormFormatterName('swSchemaFormatterDatagrid');
-    $this->widgetSchema->setNameFormat($this->schema_format_name.'[%s]');
-    
-    $this->widgetSchema->getFormFormatter()->setTranslationCatalogue('datagrid');
-    
-    $this->validatorSchema->setOption('allow_extra_fields', $this->getOption('allow_extra_fields'));
-    $this->validatorSchema->setOption('filter_extra_fields', $this->getOption('filter_extra_fields'));
-    
-    $this->addFilter(
-      'sort_by', 
-      null, 
-      new sfWidgetFormSelect(array(
-        'choices' => $this->getSortableFields()
-      )), 
-      new sfValidatorChoice(array(
-        'choices' => array_keys($this->getSortableFields()),
-        'required' => false
-      ))
-    );
-    
-    $this->addFilter(
-      'sort_order', 
-      null,
-      new sfWidgetFormSelect(array(
-        'choices' => array('ASC' => 'ASC', 'DESC' => 'DESC')
-      )), 
-      new sfValidatorChoice(array(
-        'choices' => array('ASC', 'DESC'),
-        'required' => false
-      ))
-    );
-    
-    $this->setupDatagrid();
-  }
-
-  /**
-   * 
-   * init the datagrid with the values
-   * 
-   * @return unknown_type
-   */
-  public function init()
-  {
-    $this->bind($this->getDefaults());
-    
-    $this->preparePager();
-  }
-  
-  /**
-   * define the values to use in the datagrid
-   * 
-   * @param $params
-   * @return unknown_type
-   */
-  public function prepareDefaultValues(array $params)
-  {
-
-    $session_values = array();
-    
-    if($this->getOption('store', false))
-    {
-      $session_values = $this->getStoredValues();
-    }
-
-    if(array_key_exists('reset', $params))
-    {
-      $reset = true;
-      $session_values = $params = array();
-    }
-
-    $base = count($params) == 2 ? $session_values : $params;
-    
-    $filters = array();
-    
-    foreach($this->filters as $name => $value)
-    {
-      $filters[$name] = array_key_exists($name, $base) ? $base[$name] : $value;
-    }
-
-    return $filters;
-  }
-
-  public function getStoreNamespace()
-  {
-    return $this->getOption('store_namespace', get_class($this));
-  }
-  
-  public function getStoredValues()
-  {
-    if($this->getOption('store', false) == false)
-    {
-      
-      return array();
-    }
-    
-    return sfContext::getInstance()->getUser()->getAttribute('filters', array(), $this->getStoreNamespace());
-  }
-
-  public function setStoredValues($values)
-  {
-    
-    if($this->getOption('store', false) == false)
-    {
-      
-      return ;
-    }
-    
-    sfContext::getInstance()->getUser()->setAttribute('filters', $values, $this->getStoreNamespace());
-  }
-
-  public function configure()
-  {
-  
-    $this->configureDatagrid();
-    
-  }
-
-  public function useOnly(array $fields = array(), $use_order = false)
-  {
-    
-    foreach($this as $field => $widget)
-    {
-      if(!in_array($field, $fields) && !in_array($field, array('sort_by', 'sort_order')))
-      {
-
-        $this->offsetUnset($field);
-
-        continue;
-      }
-    }
-    
-    if($use_order)
-    {
-      foreach($fields as $pos => $field)
-      {
-        $this->widgetSchema->moveField($field, sfWidgetFormSchema::LAST);
-      }
-    }
-  }
-  
-  abstract function getModelName();
-
-  function getQueryParameters($merge = array())
-  {
-    
-    $value = array_merge($this->getValues(), $merge);
-  
-    if(strlen($this->schema_format_name) > 0)
-    {
-      
-      $value = array($this->schema_format_name => $value);
-    }
-    
-    return $value;
-  }
-    
-  function getQueryString($merge = array())
-  {
-    
-    return http_build_query($this->getQueryParameters($merge));
-  }
-  
-  function setupDatagrid() {}
-
-  function configureDatagrid() {}
-
-  function buildQuery(Doctrine_Query $query) {
-
@@ -369 +47 @@
-  }
-
+  /**
+   * Query to return when the datagrid is not valid
+   * 
+   * @return Doctrine_Query
+   */
+  public function getInvalidQuery()
+  {
+    $query = $this->getBaseQuery();
+    $query->addWhere('id IS NULL'); // set an impossible query
+    
+    return $query;
+  }
+  
+  
-  public function getBaseQuery()
-  {
@@ -378 +70 @@
-  {
-    $page  = $this->getOption('page');
-buildQuery($this->getBaseQuery()
+isValid() ? $this->buildQuery($this->getBaseQuery()) : $this->getInvalidQuery(
-    $per_page = $this->getOption('per_page', 25);
-    
@@ -388 +80 @@
-  }
-
-  /**
-   * return the yaml version of the current values
-   * 
-   * @return unknown_type
-   */
-  public function getYaml($inline = 2, $indent = 0)
-  {
-    $yaml = new sfYamlDumper();
-
-    return $yaml->dump($this->getValues(), $inline, $indent);
-  }
-  
-  public function getPager()
-  {
-    
-    return $this->pager;
-  }
-  
-  // PAGER PROXY METHODS
-  public function getResults()
-  {
-    
-    return $this->pager->getResults();
-  }
-
-  public function haveToPaginate()
-  {
-    
-    return $this->pager->haveToPaginate();
-  }
-  
-  public function getPage()
-  {
-    return $this->pager->getPage();
-  }
-
-  public function getLinks()
-  {
-    
-    return $this->pager->getLinks();
-  }
-  
-  public function getLastPage()
-  {
-    
-    return $this->pager->getLastPage();
-  }
-  
-  public function getFirstPage()
-  {
-    
-    return $this->pager->getFirstPage();
-  }
-  
-  public function getCurrentMaxLink()
-  {
-    
-    return $this->pager->getCurrentMaxLink();
-  }
-  
-  public function getNextPage()
-  {
-    
-    return $this->pager->getNextPage();
-  }
-  
-  public function getPreviousPage()
-  {
-    
-    return $this->pager->getPreviousPage();
-  }
-  
-  public function count()
-  {
-    
-    return $this->pager->getNbResults();
-  }
-
-  public function getNbResults()
-  {
-    
-    return $this->pager->getNbResults();
-  }
-}