Backport PR #127

Author: phansys

Controller/TicketController.php

@@ -33,7 +33,7 @@ public function indexAction(Request $request)
         $ticketState    = $request->get('state', $this->get('translator')->trans('STATUS_OPEN'));
         $ticketPriority = $request->get('priority', null);
 
-        $query = $ticketManager->getTicketList(
+        $query = $ticketManager->getTicketListQuery(
             $userManager,
             $ticketManager->getTicketStatus($ticketState),
             $ticketManager->getTicketPriority($ticketPriority)

Manager/TicketManager.php

@@ -100,13 +100,7 @@ public function createMessage(TicketInterface $ticket = null)
     }
 
     /**
-     * Update or Create a Ticket in the database
-     * Update or Create a TicketMessage in the database.
-     *
-     * @param TicketInterface        $ticket
-     * @param TicketMessageInterface $message
-     *
-     * @return TicketInterface
+     * {@inheritdoc}
      */
     public function updateTicket(TicketInterface $ticket, TicketMessageInterface $message = null)
     {
@@ -119,13 +113,14 @@ public function updateTicket(TicketInterface $ticket, TicketMessageInterface $me
         }
         $this->objectManager->flush();
 
+        // NEXT_MAJOR: Remove the `return` statement.
         return $ticket;
     }
 
     /**
      * Delete a ticket from the database.
      *
-     * @param TicketInterface $ticket*
+     * @param TicketInterface $ticket
      */
     public function deleteTicket(TicketInterface $ticket)
     {
@@ -180,16 +175,34 @@ public function findTicketsBy(array $criteria)
     }
 
     /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since hackzilla/ticket-bundle 3.3, use `getTicketListQuery()` instead.
+     *
      * @param UserManagerInterface $userManager
      * @param int                  $ticketStatus
      * @param int                  $ticketPriority
      *
      * @return mixed
      */
     public function getTicketList(UserManagerInterface $userManager, $ticketStatus, $ticketPriority = null)
+    {
+        @trigger_error(sprintf(
+            'Method `%s()` is deprecated since hackzilla/ticket-bundle 3.3 and will be removed in version 4.0.'
+            .' Use `%s::getTicketListQuery()` instead.',
+            __METHOD__,
+            __CLASS__
+        ), E_USER_DEPRECATED);
+
+        return $query->getTicketListQuery($userManager, $ticketStatus, $ticketPriority);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTicketListQuery(UserManagerInterface $userManager, $ticketStatus, $ticketPriority = null)
     {
         $query = $this->ticketRepository->createQueryBuilder('t')
-//            ->select($this->ticketClass.' t')
             ->orderBy('t.lastMessage', 'DESC');
 
         switch ($ticketStatus) {

Manager/TicketManagerInterface.php

@@ -2,11 +2,15 @@
 
 namespace Hackzilla\Bundle\TicketBundle\Manager;
 
+use Doctrine\ORM\QueryBuilder;
 use Doctrine\Common\Persistence\ObjectManager;
 use Hackzilla\Bundle\TicketBundle\Model\TicketInterface;
 use Hackzilla\Bundle\TicketBundle\Model\TicketMessageInterface;
 use Symfony\Component\Translation\TranslatorInterface;
 
+/**
+ * @method QueryBuilder getTicketListQuery(UserManagerInterface $userManager, $ticketStatus, $ticketPriority = null)
+ */
 interface TicketManagerInterface
 {
     public function setEntityManager(ObjectManager $om);
@@ -17,6 +21,9 @@ public function createTicket();
 
     public function createMessage(TicketInterface $ticket = null);
 
+    /**
+     * @return void
+     */
     public function updateTicket(TicketInterface $ticket, TicketMessageInterface $message = null);
 
     public function deleteTicket(TicketInterface $ticket);
@@ -30,11 +37,15 @@ public function findTickets();
     public function findTicketsBy(array $criteria);
 
     /**
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since hackzilla/ticket-bundle 3.3, use `getTicketListQuery()` instead.
+     *
      * @param UserManagerInterface $userManager
      * @param int                  $ticketStatus
      * @param int                  $ticketPriority
      *
-     * @return mixed
+     * @return QueryBuilder
      */
     public function getTicketList(UserManagerInterface $userManager, $ticketStatus, $ticketPriority = null);
 

UPGRADE-3.x.md

@@ -0,0 +1,9 @@
+UPGRADE FROM 3.2 to 3.3
+=======================
+
+## Hackzilla\Bundle\TicketBundle\Manager\TicketManagerInterface and Hackzilla\Bundle\TicketBundle\Manager\TicketManager
+
+ * Deprecated method `getTicketList()` in favor of `getTicketListQuery()`.
+
+ * Deprecated relying on the return value of `updateTicket()`, since its the same object
+   provided at argument 1. This method will return void in version 4.0.