CODEWITHSUNDEEP
phpdoctrine-orm
Tschallacka
Tschallacka

Reputation: 28742

Doctrine classes, can I add custom functions?

I'm having a difficult time finding if I can add custom functions to doctrine classes.

Lets say I have

use Doctrine\ORM\Mapping as ORM;

/**
 * Map
 */
class Map
{
     /**
     * @var integer
     */
    private $id;
     /**
     * Get id
     *
     * @return integer 
     */
    public function getId()
    {
        return $this->id;
    }
}

In my classes I would like some custom functions that return values that do not per se need to be stored in databse but merely provide a checking of certain values functionality.

For examply I would like to add a function isAboveTen();

function isAboveTen()
   {
   return this->id > 10;
   }

Can I just go ahead and do this or do I need to define them as a special field in the xml file or annotations?

Upvotes: 1

Views: 157

Answers (1)

andy
andy

Reputation: 2002

You can safely add functions working on simple member types, Doctrine will ignore them if you do not add any annotations.

The question whether you should avoid doing this depends on your overall architecture and coding guidelines. As mentioned in the comments both flavors with logic possibly inside vs outside the entities exist.

However, you should keep in mind that:

All persistent properties/field of any entity class should always be private or protected, otherwise lazy-loading might not work as expected. In case you serialize entities (for example Session) properties should be protected (See Serialize section below).

Which is described in the documentation. Since you are accessing these members inside your class, magic methods like __get() will not be called.

Upvotes: 2

Related Questions