| 1 |  |  | <?php | 
            
                                                                                                            
                            
            
                                    
            
            
                | 2 |  |  | namespace keeko\tools\generator\responder; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 3 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 4 |  |  | use keeko\framework\utils\NameUtils; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 5 |  |  | use Propel\Generator\Model\Table; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 6 |  |  | use keeko\tools\model\Relationship; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 7 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 8 |  |  | class AbstractModelJsonResponderGenerator extends AbstractJsonResponderGenerator { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 9 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 10 |  |  | 	use PayloadGeneratorTrait; | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 11 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 12 |  |  | 	protected function getRelationshipIncludes(Table $model, $root = '', $processed = []) { | 
            
                                                                        
                            
            
                                    
            
            
                | 13 |  |  | 		if (in_array($model->getOriginCommonName(), $processed)) { | 
            
                                                                        
                            
            
                                    
            
            
                | 14 |  |  | 			return []; | 
            
                                                                        
                            
            
                                    
            
            
                | 15 |  |  | 		} | 
            
                                                                        
                            
            
                                    
            
            
                | 16 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 17 |  |  | 		$processed[] = $model->getOriginCommonName(); | 
            
                                                                        
                            
            
                                    
            
            
                | 18 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 19 |  |  | 		$relationships = $this->modelService->getRelationships($model); | 
            
                                                                        
                            
            
                                    
            
            
                | 20 |  |  | 		$includes = []; | 
            
                                                                        
                            
            
                                    
            
            
                | 21 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 22 |  |  | 		foreach ($relationships->getAll() as $rel) { | 
            
                                                                        
                            
            
                                    
            
            
                | 23 |  |  | 			$typeName = $rel->getRelatedTypeName(); | 
            
                                                                        
                            
            
                                    
            
            
                | 24 |  |  | 			if ($rel->getType() != Relationship::ONE_TO_ONE) { | 
            
                                                                        
                            
            
                                    
            
            
                | 25 |  |  | 				$typeName = NameUtils::pluralize($typeName); | 
            
                                                                        
                            
            
                                    
            
            
                | 26 |  |  | 			} | 
            
                                                                        
                            
            
                                    
            
            
                | 27 |  |  | 			$includeName = (!empty($root) ? $root . '.' : '') . $typeName; | 
            
                                                                        
                            
            
                                    
            
            
                | 28 |  |  | 			$includes[] = $includeName; | 
            
                                                                        
                            
            
                                    
            
            
                | 29 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 30 |  |  | 			if ($rel->getType() == Relationship::MANY_TO_MANY && $rel->getForeign() == $rel->getModel()) { | 
            
                                                                        
                            
            
                                    
            
            
                | 31 |  |  | 				$typeName = NameUtils::pluralize($rel->getReverseRelatedTypeName()); | 
            
                                                                        
                            
            
                                    
            
            
                | 32 |  |  | 				$includeName = (!empty($root) ? $root . '.' : '') . $typeName; | 
            
                                                                        
                            
            
                                    
            
            
                | 33 |  |  | 				$includes[] = $includeName; | 
            
                                                                        
                            
            
                                    
            
            
                | 34 |  |  | 			} | 
            
                                                                        
                            
            
                                    
            
            
                | 35 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 36 |  |  | // 			$foreign = $rel->getForeign(); | 
                            
                    |  |  |  | 
                                                                                        
                                                                                     | 
            
                                                                        
                            
            
                                    
            
            
                | 37 |  |  | // 			$includes = array_merge($includes, $this->getRelationshipIncludes($foreign, $includeName, $processed)); | 
            
                                                                        
                            
            
                                    
            
            
                | 38 |  |  | 		} | 
            
                                                                        
                            
            
                                    
            
            
                | 39 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 40 |  |  | 		// load additional includes from codegen | 
            
                                                                        
                            
            
                                    
            
            
                | 41 |  |  | 		$codegen = $this->codegenService->getCodegen(); | 
            
                                                                        
                            
            
                                    
            
            
                | 42 |  |  | 		$includes = array_merge($includes, $codegen->getIncludes($model->getOriginCommonName())->toArray()); | 
            
                                                                        
                            
            
                                    
            
            
                | 43 |  |  |  | 
            
                                                                        
                            
            
                                    
            
            
                | 44 |  |  | 		return $includes; | 
            
                                                                        
                            
            
                                    
            
            
                | 45 |  |  | 	} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 46 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 47 |  |  | 	protected function getModelFields(Table $model, $root = '', $processed = []) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 48 |  |  | 		if (in_array($model->getOriginCommonName(), $processed)) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 49 |  |  | 			return []; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 50 |  |  | 		} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 51 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 52 |  |  | 		$typeName = NameUtils::dasherize($model->getOriginCommonName()); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 53 |  |  | 		$relationships = $this->modelService->getRelationships($model); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 54 |  |  | 		$fields = [$typeName => $model]; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 55 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 56 |  |  | 		foreach ($relationships->getAll() as $rel) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 57 |  |  | 			$foreign = $rel->getForeign(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 58 |  |  | 			$processed[] = $foreign->getOriginCommonName(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 59 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 60 |  |  | 			$typeName = $rel->getRelatedTypeName(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 61 |  |  | 			$name = (!empty($root) ? $root . '.' : '') . $typeName; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 62 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 63 |  |  | 			$fields[$name] = $foreign; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 64 |  |  | 			$fields = array_merge($fields, $this->getModelFields($foreign, $name, $processed)); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 65 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 66 |  |  | 			if ($rel->getType() === Relationship::MANY_TO_MANY && $rel->getModel() == $rel->getForeign()) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 67 |  |  | 				$typeName = $rel->getReverseRelatedTypeName(); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 68 |  |  | 				$name = (!empty($root) ? $root . '.' : '') . $typeName; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 69 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 70 |  |  | 				$fields[$name] = $foreign; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 71 |  |  | 				$fields = array_merge($fields, $this->getModelFields($foreign, $name, $processed)); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 72 |  |  | 			} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 73 |  |  | 		} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 74 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 75 |  |  | 		return $fields; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 76 |  |  | 	} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 77 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 78 |  |  | 	protected function getFieldsCode(array $fields) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 79 |  |  | 		$code = ''; | 
            
                                                                                                            
                            
            
                                    
            
            
                | 80 |  |  | 		foreach ($fields as $typeName => $field) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 81 |  |  | 			$code .= sprintf("\t'%s' => %s::getSerializer()->getFields(),\n", $typeName, $field->getPhpName()); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 82 |  |  | 		} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 83 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 84 |  |  | 		if (strlen($code) > 0) { | 
            
                                                                                                            
                            
            
                                    
            
            
                | 85 |  |  | 			$code = substr($code, 0, -2); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 86 |  |  | 		} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 87 |  |  |  | 
            
                                                                                                            
                            
            
                                    
            
            
                | 88 |  |  | 		return sprintf("[\n%s\n]", $code); | 
            
                                                                                                            
                            
            
                                    
            
            
                | 89 |  |  | 	} | 
            
                                                                                                            
                            
            
                                    
            
            
                | 90 |  |  |  | 
            
                                                                                                            
                                                                
            
                                    
            
            
                | 91 |  |  | } | 
            
                                                        
            
                                    
            
            
                | 92 |  |  |  | 
            
                        
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.