libgraviton /
graviton
Complex classes like FileManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FileManager, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class FileManager |
||
| 26 | { |
||
| 27 | /** |
||
| 28 | * @var Filesystem |
||
| 29 | */ |
||
| 30 | private $fileSystem; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @var FileDocumentFactory |
||
| 34 | */ |
||
| 35 | private $fileDocumentFactory; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * FileManager constructor. |
||
| 39 | * |
||
| 40 | * @param Filesystem $fileSystem file system abstraction layer for s3 and more |
||
| 41 | * @param FileDocumentFactory $fileDocumentFactory Instance to be used to create action entries. |
||
| 42 | */ |
||
| 43 | public function __construct(Filesystem $fileSystem, FileDocumentFactory $fileDocumentFactory) |
||
| 44 | { |
||
| 45 | $this->fileSystem = $fileSystem; |
||
| 46 | $this->fileDocumentFactory = $fileDocumentFactory; |
||
| 47 | } |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Indicates whether the file matching the specified key exists |
||
| 51 | * |
||
| 52 | * @param string $key Identifier to be found |
||
| 53 | * |
||
| 54 | * @return boolean TRUE if the file exists, FALSE otherwise |
||
| 55 | */ |
||
| 56 | public function has($key) |
||
| 57 | { |
||
| 58 | return $this->fileSystem->has($key); |
||
| 59 | } |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Deletes the file matching the specified key |
||
| 63 | * |
||
| 64 | * @param string $key Identifier to be deleted |
||
| 65 | * |
||
| 66 | * @throws \RuntimeException when cannot read file |
||
| 67 | * |
||
| 68 | * @return boolean |
||
| 69 | */ |
||
| 70 | public function delete($key) |
||
|
|
|||
| 71 | { |
||
| 72 | return $this->fileSystem->delete($key); |
||
| 73 | } |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Reads the content from the file |
||
| 77 | * |
||
| 78 | * @param string $key Key of the file |
||
| 79 | * |
||
| 80 | * @throws \Gaufrette\Exception\FileNotFound when file does not exist |
||
| 81 | * @throws \RuntimeException when cannot read file |
||
| 82 | * |
||
| 83 | * @return string |
||
| 84 | */ |
||
| 85 | public function read($key) |
||
| 86 | { |
||
| 87 | return $this->fileSystem->read($key); |
||
| 88 | } |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Stores uploaded files to CDN |
||
| 92 | * |
||
| 93 | * @param Request $request Current Http request |
||
| 94 | * @param DocumentModel $model Model to be used to manage entity |
||
| 95 | * @param FileDocument|null $fileData meta information about the file to be stored. |
||
| 96 | * |
||
| 97 | * @return array |
||
| 98 | */ |
||
| 99 | public function saveFiles(Request $request, DocumentModel $model, FileDocument $fileData = null) |
||
| 100 | { |
||
| 101 | $inStore = []; |
||
| 102 | $files = $this->extractUploadedFiles($request); |
||
| 103 | |||
| 104 | foreach ($files as $key => $fileInfo) { |
||
| 105 | /** @var FileDocument $record */ |
||
| 106 | $record = $this->createOrUpdateRecord($model, $fileData, $request->get('id')); |
||
| 107 | $inStore[] = $record->getId(); |
||
| 108 | |||
| 109 | /** @var \Gaufrette\File $file */ |
||
| 110 | $file = $this->saveFile($record->getId(), $fileInfo['content']); |
||
| 111 | |||
| 112 | $this->initOrUpdateMetaData( |
||
| 113 | $record, |
||
| 114 | $file->getSize(), |
||
| 115 | $fileInfo, |
||
| 116 | $fileData |
||
| 117 | ); |
||
| 118 | |||
| 119 | $model->updateRecord($record->getId(), $record); |
||
| 120 | |||
| 121 | // TODO NOTICE: ONLY UPLOAD OF ONE FILE IS CURRENTLY SUPPORTED |
||
| 122 | break; |
||
| 123 | } |
||
| 124 | |||
| 125 | return $inStore; |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Save or update a file |
||
| 130 | * |
||
| 131 | * @param string $id ID of file |
||
| 132 | * @param String $data content to save |
||
| 133 | * |
||
| 134 | * @return File |
||
| 135 | * |
||
| 136 | * @throws BadRequestHttpException |
||
| 137 | */ |
||
| 138 | public function saveFile($id, $data) |
||
| 139 | { |
||
| 140 | if (is_resource($data)) { |
||
| 141 | throw new BadRequestHttpException('/file does not support storing resources'); |
||
| 142 | } |
||
| 143 | $file = new File($id, $this->fileSystem); |
||
| 144 | $file->setContent($data); |
||
| 145 | |||
| 146 | return $file; |
||
| 147 | } |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Moves uploaded files to tmp directory |
||
| 151 | * |
||
| 152 | * @param Request $request Current http request |
||
| 153 | * |
||
| 154 | * @return array |
||
| 155 | */ |
||
| 156 | private function extractUploadedFiles(Request $request) |
||
| 157 | { |
||
| 158 | $uploadedFiles = []; |
||
| 159 | |||
| 160 | /** @var $uploadedFile \Symfony\Component\HttpFoundation\File\UploadedFile */ |
||
| 161 | foreach ($request->files->all() as $field => $uploadedFile) { |
||
| 162 | if (0 === $uploadedFile->getError()) { |
||
| 163 | $content = file_get_contents($uploadedFile->getPathname()); |
||
| 164 | $uploadedFiles[$field] = [ |
||
| 165 | 'data' => [ |
||
| 166 | 'mimetype' => $uploadedFile->getMimeType(), |
||
| 167 | 'filename' => $uploadedFile->getClientOriginalName(), |
||
| 168 | 'hash' => hash('sha256', $content) |
||
| 169 | ], |
||
| 170 | 'content' => $content |
||
| 171 | ]; |
||
| 172 | } else { |
||
| 173 | throw new UploadException($uploadedFile->getErrorMessage()); |
||
| 174 | } |
||
| 175 | } |
||
| 176 | |||
| 177 | if (empty($uploadedFiles)) { |
||
| 178 | $content = $request->getContent(); |
||
| 179 | $uploadedFiles['upload'] = [ |
||
| 180 | 'data' => [ |
||
| 181 | 'mimetype' => $request->headers->get('Content-Type'), |
||
| 182 | 'filename' => '', |
||
| 183 | 'hash' => hash('sha256', $content) |
||
| 184 | ], |
||
| 185 | 'content' => $content |
||
| 186 | ]; |
||
| 187 | } |
||
| 188 | |||
| 189 | return $uploadedFiles; |
||
| 190 | } |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Creates a new or updates an existing instance of the file document |
||
| 194 | * |
||
| 195 | * @param DocumentModel $model Document model |
||
| 196 | * @param FileDocument|null $fileData File information |
||
| 197 | * @param string $id Alternative Id to be checked |
||
| 198 | * |
||
| 199 | * @return FileDocument |
||
| 200 | */ |
||
| 201 | private function createOrUpdateRecord(DocumentModel $model, FileDocument $fileData = null, $id = '') |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Updates or initialzes the metadata information of the current entity. |
||
| 220 | * |
||
| 221 | * @param FileDocument $file Document to be used |
||
| 222 | * @param integer $fileSize Size of the uploaded file |
||
| 223 | * @param array $fileInfo Additional info about the file |
||
| 224 | * @param FileDocument $fileData File data to be updated |
||
| 225 | * |
||
| 226 | * @return void |
||
| 227 | */ |
||
| 228 | private function initOrUpdateMetaData(FileDocument $file, $fileSize, array $fileInfo, FileDocument $fileData = null) |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Extracts different information sent in the request content. |
||
| 273 | * |
||
| 274 | * @param Request $request Current http request |
||
| 275 | * |
||
| 276 | * @return array |
||
| 277 | */ |
||
| 278 | public function extractDataFromRequestContent(Request $request) |
||
| 318 | |||
| 319 | /** |
||
| 320 | * Extracts meta information from request content. |
||
| 321 | * |
||
| 322 | * @param string $metadataInfoString Information about metadata information |
||
| 323 | * |
||
| 324 | * @return array |
||
| 325 | */ |
||
| 326 | private function extractMetaDataFromContent($metadataInfoString) |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Extracts file data from request content |
||
| 345 | * |
||
| 346 | * @param string $fileInfoString Information about uploaded files. |
||
| 347 | * |
||
| 348 | * @return array |
||
| 349 | */ |
||
| 350 | private function extractFileFromContent($fileInfoString) |
||
| 400 | } |
||
| 401 |
Loading history...
This check examines a number of code elements and verifies that they conform to the given naming conventions.
You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.