SfDoctrineRecord extension in symfony

Question

I added some functionality to some of my instance classes in my symfony project that I want all my instance classes to have. If I had no problems editing the main symfony installation, I would simply add my methods directly to the class sfDoctrineRecord. But I do not want to do this, of course, because my changes will block the update, plus my changes will not be well transferred to other projects.

If I want to add specific functionality to all my instance classes in symfony, what is the “right” way to do this?

(PS When I say "instance class", I mean something like lib/model/doctrine/Customer.class.php.)

Answer 1

Steps:

• Create myDoctrineRecord

  abstract class myDoctrineRecord extends sfDoctrineRecord
  {
    public function commonRecordMethod() { }
  }
  

  I put this file in the lib / record folder, but you can put it anywhere that its autoloader sees it.

• Install Symfony to use this class in the configureDoctrine callback of your ProjectConfiguration:

   public function configureDoctrine(Doctrine_Manager $manager)
   {
     sfConfig::set('doctrine_model_builder_options', array('baseClassName' => 'myDoctrineRecord'));
   }
  

What is it! Isn't that symfony? :)

Answer 2

I believe that the correct way would probably be to add a Doctrine_Template for the models in question, however you will need to define it as the behavior for each model in schema.yml

class MyMethodsTemplate extends Doctrine_Template
{
   public function customMethod1(){
      $model = $this->getInvoker();
      //do stuff with model
   }

   public function customMethod2(){
      $model = $this->getInvoker();
      //do stuff with model
   }
}

And then in your schema.yml:

ModelName:
  actAs:
   MyMethodTemplate: ~
  # the rest of your definition

After the rebuild, you can call:

$model = new ModelName();
$model->customMethod1();
$model->customMethod2(); 

Of course, Doctrine templates and listeners are much more powerful than that. You should take a look at the documentation for a decent review.