| 1 |  |  | <?php | 
            
                                                                                                            
                            
            
                                    
            
            
                | 2 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 3 |  |  | namespace Iris\Mapping; | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 4 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 5 |  |  | class SimpleCollection extends Base | 
            
                                                                        
                            
            
                                    
            
            
                | 6 |  |  | { | 
            
                                                                        
                            
            
                                    
            
            
                | 7 |  |  |     /** | 
            
                                                                        
                            
            
                                    
            
            
                | 8 |  |  |      * {@inheritdoc} | 
            
                                                                        
                            
            
                                    
            
            
                | 9 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 10 |  |  |     public function assign(array $externalData) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 11 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 12 |  |  |         $simpleCollection = new \Iris\Transfer\Catalog\SimpleCollection; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 13 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 14 |  |  |         foreach ($externalData as $c) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 15 |  |  |             $simpleCollection[] = new \Iris\Transfer\Catalog\Simple([ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 16 |  |  |                 'sku'              => $c['sku'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 17 |  |  |                 'variation'        => $c['variation'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 18 |  |  |                 'brand'            => $c['brand'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 19 |  |  |                 'color'            => $c['color'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 20 |  |  |                 'gender'           => $c['gender'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 21 |  |  |                 'color_family'     => $c['color_family'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 22 |  |  |                 'box_height'       => $c['box_height'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 23 |  |  |                 'box_width'        => $c['box_width'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 24 |  |  |                 'box_length'       => $c['box_length'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 25 |  |  |                 'weight'           => $c['weight'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 26 |  |  |                 'color_name_brand' => $c['color_name_brand'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 27 |  |  |                 'quantity'         => $c['quantity'], | 
            
                                                                                                            
                            
            
                                    
            
            
                | 28 |  |  |                 'barcode_ean'      => $c['barcode_ean'] | 
            
                                                                                                            
                            
            
                                    
            
            
                | 29 |  |  |             ]); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 30 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 31 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 32 |  |  |         return $simpleCollection; | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 33 |  |  |     } | 
            
                                                                        
                            
            
                                    
            
            
                | 34 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 35 |  |  |     /** | 
            
                                                                        
                            
            
                                    
            
            
                | 36 |  |  |      * {@inheritdoc} | 
            
                                                                        
                            
            
                                    
            
            
                | 37 |  |  |      * @param \Iris\Transfer\Catalog\SimpleCollection $internalData | 
            
                                                                        
                            
            
                                    
            
            
                | 38 |  |  |      */ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 39 |  |  |     public function map($internalData) | 
            
                                                                                                            
                            
            
                                    
            
            
                | 40 |  |  |     { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 41 |  |  |         $externalData = []; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 42 |  |  |         foreach ($internalData as $simple) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 43 |  |  |             $externalData[] = [ | 
            
                                                                                                            
                            
            
                                    
            
            
                | 44 |  |  |                 'sku'              => $simple->getSku(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 45 |  |  |                 'variation'        => $simple->getVariation(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 46 |  |  |                 'brand'            => $simple->getBrand(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 47 |  |  |                 'color'            => $simple->getColor(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 48 |  |  |                 'gender'           => $simple->getGender(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 49 |  |  |                 'color_family'     => $simple->getColorFamily(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 50 |  |  |                 'box_height'       => $simple->getBoxHeight(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 51 |  |  |                 'box_width'        => $simple->getBoxWidth(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 52 |  |  |                 'box_length'       => $simple->getBoxlength(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 53 |  |  |                 'weight'           => $simple->getWeight(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 54 |  |  |                 'color_name_brand' => $simple->getColorNameBrand(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 55 |  |  |                 'quantity'         => $simple->getQuantity(), | 
            
                                                                                                            
                            
            
                                    
            
            
                | 56 |  |  |                 'barcode_ean'      => $simple->getBarcodeEan() | 
            
                                                                                                            
                            
            
                                    
            
            
                | 57 |  |  |             ]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 58 |  |  |         } | 
            
                                                                                                            
                            
            
                                    
            
            
                | 59 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 60 |  |  |         return $externalData; | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 61 |  |  |     } | 
            
                                                        
            
                                    
            
            
                | 62 |  |  | } | 
            
                                                        
            
                                    
            
            
                | 63 |  |  |  | 
            
                        
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.