| 1 |  |  | <?php | 
            
                                                                                                            
                            
            
                                    
            
            
                | 2 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 3 |  |  | /* | 
            
                                                                                                            
                            
            
                                    
            
            
                | 4 |  |  |  * This file is part of the Sonata Project package. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 5 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 6 |  |  |  * (c) Thomas Rabaix <[email protected]> | 
            
                                                                                                            
                            
            
                                    
            
            
                | 7 |  |  |  * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 8 |  |  |  * For the full copyright and license information, please view the LICENSE | 
            
                                                                                                            
                            
            
                                    
            
            
                | 9 |  |  |  * file that was distributed with this source code. | 
            
                                                                                                            
                            
            
                                    
            
            
                | 10 |  |  |  */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 11 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 12 |  |  | namespace Sonata\NewsBundle\Document; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 13 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 14 |  |  | use Sonata\CoreBundle\Model\BaseDocumentManager; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 15 |  |  | use Sonata\DoctrineMongoDBAdminBundle\Datagrid\Pager; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 16 |  |  | use Sonata\DoctrineMongoDBAdminBundle\Datagrid\ProxyQuery; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 17 |  |  | use Sonata\NewsBundle\Model\BlogInterface; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 18 |  |  | use Sonata\NewsBundle\Model\PostManagerInterface; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 19 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 20 |  |  | class PostManager extends BaseDocumentManager implements PostManagerInterface | 
            
                                                                                                            
                            
            
                                    
            
            
                | 21 |  |  | { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 22 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 23 |  |  |      * {@inheritdoc} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 24 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 25 |  |  |     public function findOneByPermalink($permalink, BlogInterface $blog) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 26 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 27 |  |  |         $query = $this->getRepository()->createQueryBuilder('p'); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 28 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 29 |  |  |         $urlParameters = $blog->getPermalinkGenerator()->getParameters($permalink); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 30 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 31 |  |  |         $parameters = array(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 32 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 33 |  |  |         if (isset($urlParameters['year'], $urlParameters['month'], $urlParameters['day'])) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 34 |  |  |             $dateQueryParts = $this->getPublicationDateQueryParts( | 
            
                                                                                                            
                            
            
                                    
            
            
                | 35 |  |  |                 sprintf('%d-%d-%d', $urlParameters['year'], $urlParameters['month'], $urlParameters['day']), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 36 |  |  |                 'day' | 
            
                                                                                                            
                            
            
                                    
            
            
                | 37 |  |  |             ); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 38 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 39 |  |  |             $parameters = $dateQueryParts['params']; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 40 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 41 |  |  |             $query->andWhere($dateQueryParts['query']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 42 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 43 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 44 |  |  |         if (isset($urlParameters['slug'])) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 45 |  |  |             $query->andWhere('p.slug = :slug'); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 46 |  |  |             $parameters['slug'] = $urlParameters['slug']; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 47 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 48 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 49 |  |  |         if (isset($urlParameters['collection'])) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 50 |  |  |             $collectionQueryParts = $this->getPublicationCollectionQueryParts($urlParameters['collection']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 51 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 52 |  |  |             $parameters = array_merge($parameters, $collectionQueryParts['params']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 53 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 54 |  |  |             $query | 
            
                                                                                                            
                            
            
                                    
            
            
                | 55 |  |  |                 ->leftJoin('p.collection', 'c') | 
            
                                                                                                            
                            
            
                                    
            
            
                | 56 |  |  |                 ->andWhere($collectionQueryParts['query']); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 57 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 58 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 59 |  |  |         if (count($parameters) == 0) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 60 |  |  |             return; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 61 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 62 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 63 |  |  |         $query->setParameters($parameters); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 64 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 65 |  |  |         return $query->getQuery()->getSingleResult(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 66 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 67 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 68 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 69 |  |  |      * {@inheritdoc} | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 70 |  |  |      */ | 
            
                                                                        
                            
            
                                    
            
            
                | 71 |  |  |     public function getPager(array $criteria, $page, $limit = 10, array $sort = array()) | 
            
                                                                        
                            
            
                                    
            
            
                | 72 |  |  |     { | 
            
                                                                        
                            
            
                                    
            
            
                | 73 |  |  |         $parameters = array(); | 
            
                                                                        
                            
            
                                    
            
            
                | 74 |  |  |         $query = $this->getRepository() | 
            
                                                                        
                            
            
                                    
            
            
                | 75 |  |  |             ->createQueryBuilder('p') | 
            
                                                                        
                            
            
                                    
            
            
                | 76 |  |  |             ->select('p, t') | 
            
                                                                        
                            
            
                                    
            
            
                | 77 |  |  |             ->leftJoin('p.tags', 't') | 
            
                                                                        
                            
            
                                    
            
            
                | 78 |  |  |             ->orderby('p.publicationDateStart', 'DESC'); | 
            
                                                                        
                            
            
                                    
            
            
                | 79 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 80 |  |  |         // enabled | 
            
                                                                        
                            
            
                                    
            
            
                | 81 |  |  |         $criteria['enabled'] = isset($criteria['enabled']) ? $criteria['enabled'] : true; | 
            
                                                                        
                            
            
                                    
            
            
                | 82 |  |  |         $query->andWhere('p.enabled = :enabled'); | 
            
                                                                        
                            
            
                                    
            
            
                | 83 |  |  |         $parameters['enabled'] = $criteria['enabled']; | 
            
                                                                        
                            
            
                                    
            
            
                | 84 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 85 |  |  |         if (isset($criteria['date'])) { | 
            
                                                                        
                            
            
                                    
            
            
                | 86 |  |  |             $query->andWhere($criteria['date']['query']); | 
            
                                                                        
                            
            
                                    
            
            
                | 87 |  |  |             $parameters = array_merge($parameters, $criteria['date']['params']); | 
            
                                                                        
                            
            
                                    
            
            
                | 88 |  |  |         } | 
            
                                                                        
                            
            
                                    
            
            
                | 89 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 90 |  |  |         if (isset($criteria['tag'])) { | 
            
                                                                        
                            
            
                                    
            
            
                | 91 |  |  |             $query->andWhere('t.slug LIKE :tag and t.enabled = :tag_enabled'); | 
            
                                                                        
                            
            
                                    
            
            
                | 92 |  |  |             $parameters['tag'] = $criteria['tag']; | 
            
                                                                        
                            
            
                                    
            
            
                | 93 |  |  |             $parameters['tag_enabled'] = true; | 
            
                                                                        
                            
            
                                    
            
            
                | 94 |  |  |         } | 
            
                                                                        
                            
            
                                    
            
            
                | 95 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 96 |  |  |         $query->setParameters($parameters); | 
            
                                                                        
                            
            
                                    
            
            
                | 97 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 98 |  |  |         $pager = new Pager(); | 
            
                                                                        
                            
            
                                    
            
            
                | 99 |  |  |         $pager->setQuery(new ProxyQuery($query)); | 
            
                                                                        
                            
            
                                    
            
            
                | 100 |  |  |         $pager->setPage($page); | 
            
                                                                        
                            
            
                                    
            
            
                | 101 |  |  |         $pager->init(); | 
            
                                                                        
                            
            
                                    
            
            
                | 102 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 103 |  |  |         return $pager; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                        
                            
            
                                    
            
            
                | 104 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 105 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 106 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 107 |  |  |      * {@inheritdoc} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 108 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 109 |  |  |     public function getPublicationDateQueryParts($date, $step, $alias = 'p') | 
            
                                                                                                            
                            
            
                                    
            
            
                | 110 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 111 |  |  |         return array( | 
            
                                                                                                            
                            
            
                                    
            
            
                | 112 |  |  |             'query' => sprintf('%s.publicationDateStart >= :startDate AND %s.publicationDateStart < :endDate', $alias, $alias), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 113 |  |  |             'params' => array( | 
            
                                                                                                            
                            
            
                                    
            
            
                | 114 |  |  |                 'startDate' => new \DateTime($date), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 115 |  |  |                 'endDate' => new \DateTime($date.'+1 '.$step), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 116 |  |  |             ), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 117 |  |  |         ); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 118 |  |  |     } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 119 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 120 |  |  |     /** | 
            
                                                                                                            
                            
            
                                    
            
            
                | 121 |  |  |      * @param string $collection | 
            
                                                                                                            
                            
            
                                    
            
            
                | 122 |  |  |      * | 
            
                                                                                                            
                            
            
                                    
            
            
                | 123 |  |  |      * @return array | 
            
                                                                                                            
                            
            
                                    
            
            
                | 124 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 125 |  |  |     final protected function getPublicationCollectionQueryParts($collection) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 126 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 127 |  |  |         $queryParts = array('query' => '', 'params' => array()); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 128 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 129 |  |  |         if (null === $collection) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 130 |  |  |             $queryParts['query'] = 'p.collection IS NULL'; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 131 |  |  |         } else { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 132 |  |  |             $queryParts['query'] = 'c.slug = :collection'; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 133 |  |  |             $queryParts['params'] = array('collection' => $collection); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 134 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 135 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 136 |  |  |         return $queryParts; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 137 |  |  |     } | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 138 |  |  | } | 
            
                                                        
            
                                    
            
            
                | 139 |  |  |  | 
            
                        
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.