Symfony2で利用されているDoctrineについて

カテゴリーから探す

年別から見る

2021/06/04

Symfony2で利用されているDoctrineについて

今回からは、Symfonyで利用されているORMである Doctrine について紹介したいと思います。

Doctrineとは、Symfonyで利用されているORMです。つまり、DBから取得した情報を、特定のクラスと関連付けてオブジェクト化する仕組みです。この仕組みにより、直接オブジェクトとして保存や取得することができます。

以下がDoctrineを使ったCreate（生成）、Read（読み取り）、Update（更新）、Delete（削除）の簡単な例です。


<span class="token comment">/**
</span></code><code class=" language-php"><span class="token comment"> *</span></code><code class=" language-php"><span class="token comment"> @ORM\Entity</span></code><code class=" language-php">
</code><code class=" language-php"><span class="token comment"> * @ORM\Table(name="user")
 */</span>
<span class="token keyword">class</span> <span class="token class-name">User</span>
<span class="token punctuation">{</span>
   <span class="token comment">/**
    * @ORM\Id
    * @ORM\Column(type="integer")
    * @ORM\GeneratedValue(strategy="AUTO")
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$id</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @var string
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$name</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @var string
    */</span>    
    <span class="token keyword">private</span> <span class="token variable">$email</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @var string
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$password</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * @ORM\Column(type="datetime")
     */</span>
     <span class="token keyword">private</span> <span class="token variable">$createdAt</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * @ORM\ManyToOne(targetEntity="Group", inversedBy="users")
     * @ORM\JoinColumn(name="group_id", referencedColumnName="id")
     */</span>
    <span class="token keyword">private</span> <span class="token variable">$group</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * @return mixed
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getId</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">id</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @param mixed $id
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setId</span><span class="token punctuation">(</span><span class="token variable">$id</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">id</span> <span class="token operator">=</span> <span class="token variable">$id</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @return mixed
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getName</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">name</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @param mixed $name
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setName</span><span class="token punctuation">(</span><span class="token variable">$name</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">name</span> <span class="token operator">=</span> <span class="token variable">$name</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @return mixed
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getEmail</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">email</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @param mixed $email
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setEmail</span><span class="token punctuation">(</span><span class="token variable">$email</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">email</span> <span class="token operator">=</span> <span class="token variable">$email</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @return mixed
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getPassword</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">password</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @param mixed $password
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setPassword</span><span class="token punctuation">(</span><span class="token variable">$password</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">password</span> <span class="token operator">=</span> <span class="token variable">$password</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @return mixed
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getCreatedAt</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">createdAt</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @param mixed $createdAt
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">setCreatedAt</span><span class="token punctuation">(</span><span class="token variable">$createdAt</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">createdAt</span> <span class="token operator">=</span> <span class="token variable">$createdAt</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

<span class="token punctuation">}
</span>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

/**

</code><code class=" language-php"> *</code><code class=" language-php"> @ORM\Entity</code><code class=" language-php">

</code><code class=" language-php"> * @ORM\Table(name="user")

*/

class User

{

/**

* @ORM\Id

* @ORM\Column(type="integer")

* @ORM\GeneratedValue(strategy="AUTO")

*/

private $id;

/**

* @var string

*/

private $name;

/**

* @var string

*/

private $email;

/**

* @var string

*/

private $password;

/**

* @ORM\Column(type="datetime")

*/

private $createdAt;

/**

* @ORM\ManyToOne(targetEntity="Group", inversedBy="users")

* @ORM\JoinColumn(name="group_id", referencedColumnName="id")

*/

private $group;

/**

* @return mixed

*/

public function getId()

{

return $this->id;

}

/**

* @param mixed $id

*/

public function setId($id)

{

$this->id = $id;

}

/**

* @return mixed

*/

public function getName()

{

}

/**

* @param mixed $name

*/

public function setName($name)

{

$this->name = $name;

}

/**

* @return mixed

*/

public function getEmail()

{

}

/**

* @param mixed $email

*/

public function setEmail($email)

{

$this->email = $email;

}

/**

* @return mixed

*/

public function getPassword()

{

}

/**

* @param mixed $password

*/

public function setPassword($password)

{

$this->password = $password;

}

/**

* @return mixed

*/

public function getCreatedAt()

{

}

/**

* @param mixed $createdAt

*/

public function setCreatedAt($createdAt)

{

$this->createdAt = $createdAt;

}

}


<span class="token comment">// src/AppBundle/Entity/Group.php</span>
<span class="token comment">/**
 * @ORM\Entity
 * @ORM\Table(name="group")
 */</span>
<span class="token keyword">class</span> <span class="token class-name">Group</span>
<span class="token punctuation">{</span>
   <span class="token comment">/**
    * @ORM\Id
    * @ORM\Column(type="integer")
    * @ORM\GeneratedValue(strategy="AUTO")
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$id</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @var string
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$name</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @ORM\Column(nullable=true) 
    * @ORM\Column(type="text")
    */</span>    
    <span class="token keyword">private</span> <span class="token variable">$description</span><span class="token punctuation">;</span>

   <span class="token comment">/**
    * @ORM\OneToMany(targetEntity="User", mappedBy="group")
    */</span>
    <span class="token keyword">private</span> <span class="token variable">$users</span><span class="token punctuation">;</span>

    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">__construct</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">users</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">ArrayCollection</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

<span class="token punctuation">}</span>

// src/AppBundle/Entity/Group.php

/**

* @ORM\Entity

* @ORM\Table(name="group")

*/

class Group

{

/**

* @ORM\Id

* @ORM\Column(type="integer")

* @ORM\GeneratedValue(strategy="AUTO")

*/

private $id;

/**

* @var string

*/

private $name;

/**

* @ORM\Column(nullable=true)

* @ORM\Column(type="text")

*/

private $description;

/**

* @ORM\OneToMany(targetEntity="User", mappedBy="group")

*/

private $users;

public function __construct()

{

$this->users = new ArrayCollection();

}

Create（生成）


<span class="token variable">$group</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Group</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token variable">$group</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">setName</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Administrator'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token variable">$group</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">setDescription</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Users with highest privileges in the system'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> 

<span class="token variable">$em</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getDoctrine</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getManager</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">// Tells Doctrine you want to save the group (no queries yet)</span>
<span class="token variable">$em</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">persist</span><span class="token punctuation">(</span><span class="token variable">$group</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">// This line actually executes the SQL query</span>
<span class="token variable">$em</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">flush</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

$group = new Group();

$group->setName('Administrator');

$group->setDescription('Users with highest privileges in the system');

$em = $this->getDoctrine()->getManager();

// Tells Doctrine you want to save the group (no queries yet)

$em->persist($group);

// This line actually executes the SQL query

$em->flush();

Idを調べる


<span class="token variable">$group</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getId</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

1	<span class="token variable">$group</span><span class="token operator">-</span><span class="token operator">></span><span class="token function">getId</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

データーベースからデーターを調べる


<span class="token variable">$group</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getDoctrine</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
        <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getRepository</span><span class="token punctuation">(</span>'AppBundle<span class="token punctuation">:</span>Group<span class="token punctuation">)</span>
        <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">find</span><span class="token punctuation">(</span><span class="token variable">$groupId</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

$group = $this->getDoctrine()

->getRepository('AppBundle:Group)

->find($groupId);

データーベースのデーターをUpdate（更新）


<span class="token comment">// Fetch the group</span>
$em <span class="token operator">=</span> $this<span class="token punctuation">-&gt;</span><span class="token function">getDoctrine</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">-&gt;</span><span class="token function">getManager</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
$group <span class="token operator">=</span> $em<span class="token punctuation">-&gt;</span><span class="token function">getRepository</span><span class="token punctuation">(</span><span class="token lifetime-annotation symbol">'AppBundle:Group)-</span><span class="token operator">&gt;</span><span class="token function">find</span><span class="token punctuation">(</span>$groupId<span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">// If the group does not exist, throw an exception</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token operator">!</span>$group<span class="token punctuation">)</span> <span class="token punctuation">{</span>
   throw $this<span class="token punctuation">-&gt;</span><span class="token function">createNotFoundException</span><span class="token punctuation">(</span>
      <span class="token lifetime-annotation symbol">'Group</span> not found'
   <span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

<span class="token comment">// Update data</span>
$group<span class="token operator">&gt;</span><span class="token function">setDescription</span><span class="token punctuation">(</span><span class="token lifetime-annotation symbol">'New</span> group description<span class="token punctuation">.</span><span class="token lifetime-annotation symbol">');</span>
$em<span class="token punctuation">-&gt;</span><span class="token function">flush</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

// Fetch the group

$em = $this->getDoctrine()->getManager();

$group = $em->getRepository('AppBundle:Group)->find($groupId);

// If the group does not exist, throw an exception

if (!$group) {

throw $this->createNotFoundException(

'Group not found'

);

}

// Update data

$group>setDescription('New group description.');

$em->flush();

データーベースからデーターをDelete（削除）


<span class="token comment">// Fetch group</span>
$em <span class="token operator">=</span> $this<span class="token punctuation">-&gt;</span><span class="token function">getDoctrine</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">-&gt;</span><span class="token function">getManager</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
$group <span class="token operator">=</span> $em<span class="token punctuation">-&gt;</span><span class="token function">getRepository</span><span class="token punctuation">(</span><span class="token lifetime-annotation symbol">'AppBundle:Group)-</span><span class="token operator">&gt;</span><span class="token function">find</span><span class="token punctuation">(</span>$groupId<span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token comment">// Remove group</span>
$em<span class="token punctuation">-&gt;</span><span class="token function">remove</span><span class="token punctuation">(</span>$group<span class="token punctuation">)</span><span class="token punctuation">;</span>
$em<span class="token punctuation">-&gt;</span><span class="token function">flush</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>