So this is what we want to achieve.

Example of Changing order for elements

So first things first, let me define the schema that I am was using:

ReportXReportModule:
  columns:
    id:                                 { type: integer(4), notnull: true, primary: true, autoincrement: true}
    report_id:                      { type: integer(4), notnull: true}
    report_module_id:         { type: integer(4), notnull: true}
    module_order:               { type: integer(2), notnull: true}

The module_order is the field to be used to store the order of the module. So here’s adding a bunch of methods in the model class. So the requirement for this task is that the entry is also to be identified by the report. So in case you need to use these methods, you would have to adapt it to your requirement.
New methods in ReportXReportModuleTable.class.php
Fetch a report by Report ID and Order

  public static function getByReportAndOrder($report_id, $module_order)
  {
    $data = Doctrine_Query::create()
          ->from('ReportXReportModule rrm')
          ->where('rrm.report_id = ?', $report_id)
          ->andWhere('rrm.module_order = ?', $module_order)
          ->fetchOne();
    if (!$data) {
      return false;
    }
    // send this back if this a sensible record
    return $data;
  }

For the given report find the highest value of order

  public static function getMaxOrderByReport($report_id)
  {
    $order = 0;
    if (!is_numeric($report_id)) {
      return $order;
    }
    $record = Doctrine_Query::create()
                ->select('MAX(rrm.module_order)')
                ->from('ReportXReportModule rrm')
                ->where('rrm.report_id = ?', $report_id)
                ->fetchArray();

    if (count($record) != 1) {
      return $order;
    } else {
      if (isset($record[0]['MAX'])) {
        $order = $record[0]['MAX'];
      }
    }

    return $order;
  }

New methods in ReportXReportModuleTable.class.php.


Get all the records for a given report ID and return them sorted by their order (ranking)

  public static function getModulesByReport($report_id)
  {
    $records = array();
    if (!is_numeric($report_id)) {
      return $records;
    }
    $records = Doctrine_Query::create()
                ->from('ReportXReportModule rrm')
                ->where('rrm.report_id = ?', $report_id)
                ->leftJoin('rrm.ReportModule rm')
                ->orderBy('rrm.module_order asc')
                ->fetchArray();
    return $records;
  }

This is an interesting method, this is used to swap a record with another record. You shall see how this method is useful for the up and down actions that will follow shortly. This is also done within a transaction to ensure that the integrity of the order for modules is retained.

  public function swapWith($module)
  {
    $conn = Doctrine_Manager::connection();
    try {
      $conn->beginTransaction();
        $order = $this->getModuleOrder();
        $this->setModuleOrder($module->getModuleOrder());
        $this->save();
        $module->setModuleOrder($order);
        $module->save();
      $conn->commit();
    } catch (Doctrin_Exception $e) {
      $conn->rollback();
    }
  }

This method is useful to delete a module. This not only just deletes the entry but also updates the order of the reset of the modules with a order higher than the current module.

  public function deleteByReport($report_id)
  {
    $conn = Doctrine_Manager::connection();
    try {
      $conn->beginTransaction();
      // decrease all the orders by 1 for all elements that have a rank greater than this rank
      // execute custom sql to do that
      $q = Doctrine_Query::create()
            ->update('ReportXReportModule rrm')
            ->set('rrm.module_order','rrm.module_order - 1' )
            ->where('rrm.module_order > ?', $this->module_order)
            ->execute();

      $this->delete();
      $conn->commit();

    } catch(Doctrin_Exception $e) {
      $conn->rollback();
    }
  }

Now that we have all the required methods in our model classes, its time to write the first action that will display all the modules. So the code snippet from the action is:

  public function executeIndex(sfWebRequest $request)
  {
    // get the list of all the modules
    $this->report_modules = ReportXReportModuleTable::getModulesByReport($this->current_report->getId());
    $this->max_order      = ReportXReportModuleTable::getMaxOrderByReport($this->current_report->getId());
    }

and the corresponding template for that is:

<h2>List Of Current Modules</h2>
<?php if (count($report_modules)> 0) : ?>
  <ol class="report-modules">
  <?php foreach($report_modules as $module): ?>
    <li>
      <div class="name">
        <?= $module['ReportModule']['name']?>
      </div>
      <div class="order">
        <?php if ($module['module_order'] > 0) : ?>
          <?= link_to('Up', 'reportmodulemanager/up?id=' . $module['id'])?>
        <?php endif;?>

        <?php if ($module['module_order'] != $max_order) : ?>
          <?= link_to('Down', 'reportmodulemanager/down?id=' . $module['id'])?>
        <?php endif;?>
      </div>
      <div class="action">
        <?php if (1 == $module['ReportModule']['require_local_configuration']) : ?>
          <?= link_to('Configure', 'reportmodulemanager/configure?id=' . $module['id'])?>
        <?php endif;?>
        <?= link_to('Remove', 'reportmodulemanager/delete?id=' . $module['id'])?>
      </div>

    </li>
  <?php endforeach;?>
  </ol>
<?php endif?>

As you can see each module has an up option only when its order is greater than 0. Similarly the module has a down option only when its order is not the same as the highest value for order

Now tying in the up and down actions.

  public function executeUp(sfWebRequest $request)
  {
    $reportmodule = Doctrine::getTable('ReportXReportModule');
    $item = $reportmodule->find($request->getParameter('id'));
    $this->forward404Unless($item);

    $previous_item = ReportXReportModuleTable::getByReportAndOrder(
        $this->current_report->getId(),
        ($item->getModuleOrder() - 1)
      );
    $this->forward404Unless($previous_item);

    $item->swapWith($previous_item);
    $this->redirect('reportmodulemanager/index');
  }

and the for the down action:

public function executeDown(sfWebRequest $request)
  {
    $reportmodule = Doctrine::getTable('ReportXReportModule');
    $item = $reportmodule->find($request->getParameter('id'));
    $this->forward404Unless($item);

    $next_item = ReportXReportModuleTable::getByReportAndOrder(
        $this->current_report->getId(),
        ($item->getModuleOrder() + 1)
      );
    $this->forward404Unless($next_item);

    $item->swapWith($next_item);
    $this->redirect('reportmodulemanager/index');
  }
 

As you can see we swap a module with one after it for the Up action, similarly we swap a module with one after it for the down action.

And that’s pretty much it to have a list that can be sorted. The other interesting actions would be when you add a new record or remove on. At this point you must have figured out that adding a new record should be pretty straight forward as you have now methods to access the highest rank using the method ReportXReportModuleTable::getMaxOrderByReport

As a part of this post, one day I shall add how to progressively enhance so give it a fancy drag and drop interface as suggested in the original article. However if you have any questions or suggestions to make this better, please feel free to leave a note below.

1. CSRF Protection
2. Take advantage of symfony validation
3. Work in the same consistent manner as the rest of the form classes

This is what I came up with. Create a custom form class that extends BaseForm. Override the configure function to define the custom fields and validations

class ProviderInfoReportForm extends BaseForm
{
  public function configure()
  {
    $this->setWidgets(array(
          'name' => new sfWidgetFormInputText()
        )
      );
    $this->validatorSchema['name'] = new sfValidatorString(
      array(
          'max_length' => 100,
          'required' => true
        ),
      array(
          'required' => 'last name required'
        )
    );

    $this->widgetSchema->setNameFormat('provider_info_report[%s]');
    $this->errorSchema = new sfValidatorErrorSchema($this->validatorSchema);
    parent::setup();
  }
}

and then access the form inside the template the regular way.

      <form action="<?= url_for('@report_provider_profile_report')?>" method="post" accept-charset="utf-8">
        <?= $form->renderGlobalErrors() ?>
        <?= $form->renderHiddenFields() ?>
        <?php echo $form['name']->renderError() ?>
        <?php echo $form['name']->renderLabel() ?>
     </form>

ensure that the renderHiddenFields() call is in place otherwise you would end up getting csrf_token required all over the place.

public function configure()
{
  $this->widgetSchema['my_field'] =
    new sfWidgetFormTextArea(array('required' => false));
  // add the validator
  $this->validatorSchema['my_field']   = new sfValidatorCallback(
      array('callback' => array(
          array($this, 'my_valdiation_function')   // if you write the function in the validator itself
          // array($this->getObject(), 'my_valdiation_function')   // or if you move it to your model object
        ))
    );
}

As you can see form the code, I have commented out a line, that’s if you think its a good idea to move the validator to the model. I am not sure if I buy that idea but this what I have seen some developers do. I guess it kinda depends on what they are after, I would rather keep it all together unless it has its value in being shared across other classes.

And finally the signature for actual callback function:

public function my_valdiation_function($validator, $value) {
  if ($condition_is_satisfied) {
    return $value;
  } else {
    $message = 'message detailing reason for EPIC FAIL!';
    throw new sfValidatorError($validator, $message);
  }
}

Note: This process works for symfony 1.2 onwards (currently using 1.4)

So the first thing to do is write a custom form class that extends the sfGuardUser.class.php were you can add your additional fields and validation like password, password_confirmation, accepting terms and conditions etc. Also this is the place where you would need to disable the fields that you don’t in the register form. The class below is called RegisterForm.class.php and i have tried to keep it pretty documented as possible.

<?php
/**
 * RegisterForm for signup process and requires
 * sfGuardPlugin
 *
 * @author Rajat Pandit
 */
class RegisterForm extends sfGuardUserForm {
    public function configure()
    {
        // remove the fields that you no longer need
        unset(
            $this['is_active'],
            $this['is_super_admin'],
            $this['updated_at'],
            $this['groups_list'],
            $this['permissions_list'],
            $this['last_login'],
            $this['created_at'],
            $this['salt'],
            $this['algorithm']
            );

        // change the name format as we dont want to the
        // world to know that we are using sfGuardPlugin
        $this->widgetSchema->setNameFormat('signup[%s]');

        // Setup proper password validation with confirmation
        $this->widgetSchema['password']                 = new sfWidgetFormInputPassword();
        $this->widgetSchema['password_confirmation']    = new sfWidgetFormInputPassword();
        $this->widgetSchema['toc']                      = new sfWidgetFormInputCheckbox();

        $this->widgetSchema->setLabel('username', 'Email');
        $this->widgetSchema->setLabel(
                'password_confirmation',
                'Confirm Password'
            );
        $this->widgetSchema->setLabel(
                'toc',
                'I agree to the Terms of Service, Privacy, & Refund policies'
            );

        $this->validatorSchema['username'] 	= new sfValidatorEmail(
                array(),
                array(
                        'required' => 'Please provide an email address',
                        'invalid'  => 'Please enter a valid email address'
                     )
                    );
        $this->validatorSchema['toc']       = new sfValidatorBoolean(
                                        array('required' => true),
                                        array(
                                            'required' =>
                                            'You need to accept the terms and conditions to proceed')
                                             );

        $this->validatorSchema['password_confirmation'] = clone $this->validatorSchema['password'];
        $this->validatorSchema['password']->setOption('required', true);
        $this->widgetSchema->moveField('password_confirmation', 'after', 'password');
        $this->mergePostValidator(new sfValidatorSchemaCompare('password',
                                        sfValidatorSchemaCompare::EQUAL, 'password_confirmation',
                                        array(),
                                        array(
                                                'required' => 'You are required to enter a password'
                                            )));

    }
}

The next thing is to create a template that will represent this form. I shall leave that as an exercise for the user. You can read more about it on the symfony documentation section.

Now in your action, you need to write the bit of code that will send the form object to the view and then handle saving the object. The other interesting thing I am doing in my action is to create and update the profile table as well. The schema that i have used for profile table is as follows, its important to have all the values in the relations section to be setup properly otherwise the sfGuardUser()->getProfile() won’t work.

sf_guard_user_profile:
  actAs:
    Timestampable: ~
  columns:
    user_id:                      { type: integer(4), notnull: true}
    first_name:                   { type: string(200)}
    last_name:                    { type: string(200)}
    token:                        { type: string(32) }
  relations:
    User:
      class: sfGuardUser
      local: user_id
      foreign: id
      foreignAlias: Profile
      foreignType: one
      type: one
      onDelete: CASCADE

The code for the action is as follows:

  public function executeRegister(sfWebRequest $request)
  {
      $params = $request->getParameter('signup');
      $this->form = new RegisterForm();
      if ($request->isMethod('post')) {
          $this->form->bind($params);
          // save the object is the user
          // details entered a correct and everything else is place.
          if ($this->form->isValid()) {
              $this->form->save();
              // get the user object
              $user = $this->form->getObject();

              // get the normal user group
              $normal_user_group = sfConfig::get('app_config_normal_user');

              // deactivate the account, till the user verifies the account
              $user->setIsActive(false);

              // set the activation token
              $profile = $user->getProfile();
              $profile->setToken(md5(time()));

              // notify the user about the signup
              $this->notifySignup($user, $profile);
              $user->save(); // save the record in the database

              $this->getUser()->setFlash('register_confirm', true);
          }
      }
  }

Just as an additional note, this is not a copy-paste-use solution, this is just a pointer of how you can get something working and then write additional code in the right place to extend things. Leave a comment if you have a question and I would be happy to answer it.

If you want to create an individual table to be utf-8 then in the schema.yml you can add.

User:
  options:
    type: MyISAM
    collate: utf8_unicode_ci
    charset: utf8
  columns:
    username: string(255)
    password: string(255)

However this can be a painful repetitive task, especially if you have loads and loads of tables to work with. In case you are like me and prefer all your tables to be utf-8 by default, you can add this function to your ProjectConfiguration.class.php file.

  public function configureDoctrine(Doctrine_Manager $manager)
  {
    $manager->setCollate('utf8_unicode_ci');
    $manager->setCharset('utf8');
  }

and then rebuild all the models (and possibly load your fixtures if you have any.

# symfony doctrine:build --all --and-load --env=dev --no-confirmation

Obviously bare in mind that this will drop your database and re-create the tables with utf-8 encoding.

If anyone has any suggestions for my problem, do leave a comment.

# sudo pear upgrade symfony/symfony

But it seems that the channel details have updated you would require updating that first and then you can upgrade to symfony 1.4. This is what i did.

rp@devbox:/usr/share/php/symfony$ sudo pear channel-update pear.symfony-project.com
Updating channel "pear.symfony-project.com"
Update of Channel "pear.symfony-project.com" succeeded

rp@devbox:/usr/share/php/symfony$ sudo pear upgrade symfony/symfony
downloading symfony-1.4.0.tgz ...
Starting to download symfony-1.4.0.tgz (3,145,121 bytes)
............................................
............................................
done: 3,145,121 bytes
upgrade ok: channel://pear.symfony-project.com/symfony-1.4.0
rp@devbox:/usr/share/php/symfony$

Hope this helps someone else trying to upgrade as well.

rp@devbox:trunk$ php symfony --trace doctrine:build-all-reload --no-confirmation
>> doctrine  dropping databases
>> doctrine  Successfully dropped database f...octrine" named "secret_project"
>> doctrine  creating databases
>> doctrine  Successfully created database f...octrine" named "secret_project"
>> doctrine  generating model classes

  [Doctrine_Parser_Exception]
  Unable to parse string: Unable to parse line 0 (  

Exception trace:
  at ...
....

Then look no further, this was the oddest error message which caused errors inconsistently when generating models or updating the schema files. It turned out that the error was due to

• vim swap files
• osx ._ files

The parser would pick up all the files even if it started with a . (dot) which then borks of-course coz it wasn’t in the format it would expect it to be in

What would have been useful would be to have more meaningful error message like full path+file name and also the parser shouldnt pickup . (dot) files in the first place, dont see why a developer would want to keep his config files starting with a . (dot) unless its a .htaccess file.

Propel::getConnection('connection_name')->executeUpdate('TRUNCATE TABLE put_table_name_here');

Creating svn directories

svn mkdir -m "create default directories" http://svn.clients.rajatpandit.com/project-name/trunk http://svn.clients.rajatpandit.com/project-name/tags http://svn.clients.rajatpandit.com/project-name/branches

Checkout these directories locally:

svn co http://svn.clients.rajatpandit.com/project-name/ .

Move to the trunk directory

cd trunk

Creating a new project

$  symfony generate:project brp
$ php symfony generate:app --escaping-strategy=on --csrf-secret=s3cr3t fe

Clear cache and log and add that to svn

rm -rf cache/* log/*
chmod 777 cache/ log/
svn add *

svn propedit svn:ignore cache
svn propedit svn:ignore log

Enter * in both the cases so that no files in cache and log get commited to svn

Add the new files to svn

svn ci -m 'adding the initial set of files'

Update the database settings, add the doctrine plugin and disable the propel plugin instead, edit the file config/ProjectConfiguration.class.php
and update the line with the following line:

  $this->enableAllPluginsExcept(array('sfPropelPlugin', 'sfCompat10Plugin'));

Publish the plug-in assets

rp@devbox:~/websites/project-name/trunk$ php symfony plugin:publish-assets
    plugin    Configuring plugin - sfProtoculousPlugin
    plugin    Configuring plugin - sfDoctrinePlugin

Delete the files for the propel plugin:

svn delete web/sfPropelPlugin
svn delete config/propel.ini
svn delete config/schema.yml
svn mkdir config/doctrine

Create new schema file and remove the default schema file.

rp@devbox:~/websites/project-name/trunk$ cd config/doctrine/
rp@devbox:~/websites/project-name/trunk/config/doctrine$ touch schema.yml
rp@devbox:~/websites/project-name/trunk/config/doctrine$ svn add schema.yml
A         schema.yml
rp@devbox:~/websites/project-name/trunk/config/doctrine$ svn ci -m 'adding schema for app'

svn delete config/databases.yml
svn ci -m 'removed the default databases.yml file'

Add database configuration settings:

php symfony configure:database --name=doctrine --class=sfDoctrineDatabase "mysql:host=127.0.0.1;dbname=project1" root password

Link to externals so that the latest version of the plugins and symfony gets checked out:

cd lib/
svn mkdir vendor
svn propedit svn:externals lib/vendor
svn ci -m 'updating symfony to version 1.2.7'
svn update lib/vendor/

That pulls out the most updated tagged version of symfony.

Update the configuration file config/ProjectConfiguration.class.php to use the local symfony version instead of the site-wide settings.

require_once dirname(__FILE__) . '/../lib/vendor/symfony/lib/autoload/sfCoreAutoload.class.php';

If you want to write code for a criteria object for the SQL statement which is something like this.

SELECT field1, field2 from table1 where field1 in (5,30,23)

The corresponding PHP for that would be as follows

$values = array(5,30,23);
$criteria_for_select = new Criteria();
$c = new Criteria();
$criteria_for_select = $c->getNewCriterion(table1::field1, $values, Criteria::IN);

That’s pretty much it, now this criteria object $criteria_for_select can now be used in your doSelectXXX calls.

Another really cool app that automates the task of writing criteria object is availabile here.
http://propel.jondh.me.uk/

The cool thing about this utility is you drop in your selection condition and it will write the code for the criteria object for you, now that’s really cool.