Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 22 | class FileController extends RestController |
||
| 23 | { |
||
| 24 | /** |
||
| 25 | * @var FileManager |
||
| 26 | */ |
||
| 27 | private $fileManager; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * @var RequestManager |
||
| 31 | */ |
||
| 32 | private $requestManager; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * On build time we inject the Manager |
||
| 36 | * |
||
| 37 | * @param FileManager $fileManager Service Manager |
||
| 38 | * |
||
| 39 | * @return void |
||
| 40 | */ |
||
| 41 | public function setFileManager(FileManager $fileManager) |
||
| 42 | { |
||
| 43 | $this->fileManager = $fileManager; |
||
| 44 | } |
||
| 45 | |||
| 46 | /** |
||
| 47 | * set RequestManager |
||
| 48 | * |
||
| 49 | * @param RequestManager $requestManager requestManager |
||
| 50 | * |
||
| 51 | * @return void |
||
| 52 | */ |
||
| 53 | public function setRequestManager($requestManager) |
||
| 54 | { |
||
| 55 | $this->requestManager = $requestManager; |
||
| 56 | } |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Writes a new Entry to the database |
||
| 60 | * Can accept either direct Post data or Form upload |
||
| 61 | * |
||
| 62 | * @param Request $request Current http request |
||
| 63 | * |
||
| 64 | * @return Response $response Result of action with data (if successful) |
||
| 65 | */ |
||
| 66 | View Code Duplication | public function postAction(Request $request) |
|
| 67 | { |
||
| 68 | $file = new File(); |
||
| 69 | $request = $this->requestManager->updateFileRequest($request); |
||
| 70 | |||
| 71 | if ($formData = $request->get('metadata')) { |
||
| 72 | $file = $this->restUtils->validateRequest($formData, $this->getModel()); |
||
| 73 | } |
||
| 74 | |||
| 75 | /** @var FileModel $model */ |
||
| 76 | $model = $this->getModel(); |
||
| 77 | $file = $this->fileManager->handleSaveRequest($file, $request, $model); |
||
| 78 | |||
| 79 | // Set status code and content |
||
| 80 | $response = $this->getResponse(); |
||
| 81 | $response->setStatusCode(Response::HTTP_CREATED); |
||
| 82 | $response->headers->set( |
||
| 83 | 'Location', |
||
| 84 | $this->getRouter()->generate('gravitondyn.file.rest.file.get', array('id' => $file->getId())) |
||
| 85 | ); |
||
| 86 | return $response; |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * respond with document if non json mime-type is requested |
||
| 91 | * |
||
| 92 | * @param Request $request Current http request |
||
| 93 | * @param string $id id of file |
||
| 94 | * |
||
| 95 | * @return Response |
||
| 96 | */ |
||
| 97 | public function getAction(Request $request, $id) |
||
| 98 | { |
||
| 99 | // If a json request, let parent handle it |
||
| 100 | if (in_array('application/json', $request->getAcceptableContentTypes())) { |
||
| 101 | return parent::getAction($request, $id); |
||
| 102 | } |
||
| 103 | |||
| 104 | /** @var File $file */ |
||
| 105 | $file = $this->getModel()->find($id); |
||
| 106 | |||
| 107 | /** @var Response $response */ |
||
| 108 | return $this->fileManager->buildGetContentResponse( |
||
| 109 | $this->getResponse(), |
||
| 110 | $file |
||
| 111 | ); |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Update a record |
||
| 116 | * |
||
| 117 | * @param Number $id ID of record |
||
| 118 | * @param Request $request Current http request |
||
| 119 | * |
||
| 120 | * @return Response $response Result of action with data (if successful) |
||
| 121 | */ |
||
| 122 | View Code Duplication | public function putAction($id, Request $request) |
|
| 123 | { |
||
| 124 | $request = $this->requestManager->updateFileRequest($request); |
||
| 125 | /** @var FileModel $model */ |
||
| 126 | $model = $this->getModel(); |
||
| 127 | |||
| 128 | $file = new File(); |
||
| 129 | if ($metadata = $request->get('metadata', false)) { |
||
| 130 | $file = $this->restUtils->validateRequest($metadata, $model); |
||
| 131 | } |
||
| 132 | |||
| 133 | $file = $this->fileManager->handleSaveRequest($file, $request, $model); |
||
| 134 | |||
| 135 | // Set status code and content |
||
| 136 | $response = $this->getResponse(); |
||
| 137 | $response->setStatusCode(Response::HTTP_NO_CONTENT); |
||
| 138 | $response->headers->set( |
||
| 139 | 'Location', |
||
| 140 | $this->getRouter()->generate('gravitondyn.file.rest.file.get', array('id' => $file->getId())) |
||
| 141 | ); |
||
| 142 | |||
| 143 | return $response; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Deletes a record |
||
| 148 | * |
||
| 149 | * @param Number $id ID of record |
||
| 150 | * |
||
| 151 | * @return Response $response Result of the action |
||
| 152 | */ |
||
| 153 | public function deleteAction($id) |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Patch a record, we add here a patch on Modification Data. |
||
| 162 | * |
||
| 163 | * @param Number $id ID of record |
||
| 164 | * @param Request $request Current http request |
||
| 165 | * |
||
| 166 | * @throws MalformedInputException |
||
| 167 | * |
||
| 168 | * @return Response $response Result of action with data (if successful) |
||
| 169 | */ |
||
| 170 | public function patchAction($id, Request $request) |
||
| 202 | } |
||
| 203 |