Complex classes like DMSUploadField 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 DMSUploadField, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
15 | class DMSUploadField extends UploadField |
||
16 | { |
||
17 | private static $allowed_actions = array( |
||
|
|||
18 | "upload", |
||
19 | ); |
||
20 | |||
21 | /** |
||
22 | * The temporary folder name to store files in during upload |
||
23 | * @var string |
||
24 | */ |
||
25 | protected $folderName = 'DMSTemporaryUploads'; |
||
26 | |||
27 | /** |
||
28 | * Override the default behaviour of the UploadField and take the uploaded file (uploaded to assets) and |
||
29 | * add it into the DMS storage, deleting the old/uploaded file. |
||
30 | * @param File |
||
31 | */ |
||
32 | protected function attachFile($file) |
||
33 | { |
||
34 | $dms = DMS::inst(); |
||
35 | $record = $this->getRecord(); |
||
36 | |||
37 | if ($record instanceof DMSDocument) { |
||
38 | // If the edited record is a document, |
||
39 | // assume we're replacing an existing file |
||
40 | $doc = $record; |
||
41 | $doc->ingestFile($file); |
||
42 | } else { |
||
43 | // Otherwise create it |
||
44 | $doc = $dms->storeDocument($file); |
||
45 | $file->delete(); |
||
46 | } |
||
47 | |||
48 | // Relate to the underlying document set being edited. |
||
49 | // Not applicable when editing the document itself and replacing it, or uploading from the ModelAdmin |
||
50 | if ($record instanceof DMSDocumentSet) { |
||
51 | $record->Documents()->add($doc, array('ManuallyAdded' => 1)); |
||
52 | } |
||
53 | |||
54 | return $doc; |
||
55 | } |
||
56 | |||
57 | public function validate($validator) |
||
58 | { |
||
59 | return true; |
||
60 | } |
||
61 | |||
62 | /** |
||
63 | * Action to handle upload of a single file |
||
64 | * |
||
65 | * @param SS_HTTPRequest $request |
||
66 | * @return string json |
||
67 | */ |
||
68 | public function upload(SS_HTTPRequest $request) |
||
69 | { |
||
70 | if ($recordId = $request->postVar('ID')) { |
||
71 | $this->setRecord(DMSDocumentSet::get()->byId($recordId)); |
||
72 | } |
||
73 | |||
74 | if ($this->isDisabled() || $this->isReadonly()) { |
||
75 | return $this->httpError(403); |
||
76 | } |
||
77 | |||
78 | // Protect against CSRF on destructive action |
||
79 | $token = $this->getForm()->getSecurityToken(); |
||
80 | if (!$token->checkRequest($request)) { |
||
81 | return $this->httpError(400); |
||
82 | } |
||
83 | |||
84 | $name = $this->getName(); |
||
85 | $tmpfile = $request->postVar($name); |
||
86 | $record = $this->getRecord(); |
||
87 | |||
88 | // Check if the file has been uploaded into the temporary storage. |
||
89 | if (!$tmpfile) { |
||
90 | $return = array('error' => _t('UploadField.FIELDNOTSET', 'File information not found')); |
||
91 | } else { |
||
92 | $return = array( |
||
93 | 'name' => $tmpfile['name'], |
||
94 | 'size' => $tmpfile['size'], |
||
95 | 'type' => $tmpfile['type'], |
||
96 | 'error' => $tmpfile['error'] |
||
97 | ); |
||
98 | } |
||
99 | |||
100 | // Check for constraints on the record to which the file will be attached. |
||
101 | if (!$return['error'] && $this->relationAutoSetting && $record && $record->exists()) { |
||
102 | $tooManyFiles = false; |
||
103 | // Some relationships allow many files to be attached. |
||
104 | if ($this->getConfig('allowedMaxFileNumber') && ($record->hasMany($name) || $record->manyMany($name))) { |
||
105 | if (!$record->isInDB()) { |
||
106 | $record->write(); |
||
107 | } |
||
108 | $tooManyFiles = $record->{$name}()->count() >= $this->getConfig('allowedMaxFileNumber'); |
||
109 | // has_one only allows one file at any given time. |
||
110 | } elseif ($record->hasOne($name)) { |
||
111 | $tooManyFiles = $record->{$name}() && $record->{$name}()->exists(); |
||
112 | } |
||
113 | |||
114 | // Report the constraint violation. |
||
115 | if ($tooManyFiles) { |
||
116 | if (!$this->getConfig('allowedMaxFileNumber')) { |
||
117 | $this->setConfig('allowedMaxFileNumber', 1); |
||
118 | } |
||
119 | $return['error'] = _t( |
||
120 | 'UploadField.MAXNUMBEROFFILES', |
||
121 | 'Max number of {count} file(s) exceeded.', |
||
122 | array('count' => $this->getConfig('allowedMaxFileNumber')) |
||
123 | ); |
||
124 | } |
||
125 | } |
||
126 | |||
127 | // Process the uploaded file |
||
128 | if (!$return['error']) { |
||
129 | $fileObject = null; |
||
130 | |||
131 | if ($this->relationAutoSetting) { |
||
132 | // Search for relations that can hold the uploaded files. |
||
133 | if ($relationClass = $this->getRelationAutosetClass()) { |
||
134 | // Create new object explicitly. Otherwise rely on Upload::load to choose the class. |
||
135 | $fileObject = SS_Object::create($relationClass); |
||
136 | } |
||
137 | } |
||
138 | |||
139 | // Get the uploaded file into a new file object. |
||
140 | try { |
||
141 | $this->upload->loadIntoFile($tmpfile, $fileObject, $this->getFolderName()); |
||
142 | } catch (Exception $e) { |
||
143 | // we shouldn't get an error here, but just in case |
||
144 | $return['error'] = $e->getMessage(); |
||
145 | } |
||
146 | |||
147 | if (!$return['error']) { |
||
148 | if ($this->upload->isError()) { |
||
149 | $return['error'] = implode(' ' . PHP_EOL, $this->upload->getErrors()); |
||
150 | } else { |
||
151 | $file = $this->upload->getFile(); |
||
152 | |||
153 | // CUSTOM Attach the file to the related record. |
||
154 | $document = $this->attachFile($file); |
||
155 | |||
156 | // Collect all output data. |
||
157 | $return = array_merge($return, array( |
||
158 | 'id' => $document->ID, |
||
159 | 'name' => $document->getTitle(), |
||
160 | 'thumbnail_url' => $document->Icon($document->getExtension()), |
||
161 | 'edit_url' => $this->getItemHandler($document->ID)->EditLink(), |
||
162 | 'size' => $document->getFileSizeFormatted(), |
||
163 | 'buttons' => (string) $document->renderWith($this->getTemplateFileButtons()), |
||
164 | 'showeditform' => true |
||
165 | )); |
||
166 | |||
167 | // CUSTOM END |
||
168 | } |
||
169 | } |
||
170 | } |
||
171 | $response = new SS_HTTPResponse(Convert::raw2json(array($return))); |
||
172 | $response->addHeader('Content-Type', 'text/plain'); |
||
173 | return $response; |
||
174 | } |
||
175 | |||
176 | |||
177 | /** |
||
178 | * Never directly display items uploaded |
||
179 | * @return SS_List |
||
180 | */ |
||
181 | public function getItems() |
||
182 | { |
||
183 | return new ArrayList(); |
||
184 | } |
||
185 | |||
186 | public function Field($properties = array()) |
||
187 | { |
||
188 | $fields = parent::Field($properties); |
||
189 | |||
190 | // Replace the download template with a new one only when access the upload field through a GridField. |
||
191 | // Needs to be enabled through setConfig('downloadTemplateName', 'ss-dmsuploadfield-downloadtemplate'); |
||
192 | Requirements::javascript(DMS_DIR . '/javascript/DMSUploadField_downloadtemplate.js'); |
||
193 | |||
194 | // In the add dialog, add the addtemplate into the set of file that load. |
||
195 | Requirements::javascript(DMS_DIR . '/javascript/DMSUploadField_addtemplate.js'); |
||
196 | |||
197 | return $fields; |
||
198 | } |
||
199 | |||
200 | /** |
||
201 | * @param int $itemID |
||
202 | * @return UploadField_ItemHandler |
||
203 | */ |
||
204 | public function getItemHandler($itemID) |
||
205 | { |
||
206 | return DMSUploadField_ItemHandler::create($this, $itemID); |
||
207 | } |
||
208 | |||
209 | |||
210 | /** |
||
211 | * FieldList $fields for the EditForm |
||
212 | * @example 'getCMSFields' |
||
213 | * |
||
214 | * @param File $file File context to generate fields for |
||
215 | * @return FieldList List of form fields |
||
216 | */ |
||
217 | public function getDMSFileEditFields($file) |
||
242 | |||
243 | /** |
||
244 | * FieldList $actions or string $name (of a method on File to provide a actions) for the EditForm |
||
245 | * @example 'getCMSActions' |
||
246 | * |
||
247 | * @param File $file File context to generate form actions for |
||
248 | * @return FieldList Field list containing FormAction |
||
249 | */ |
||
250 | public function getDMSFileEditActions($file) |
||
272 | |||
273 | /** |
||
274 | * Determines the validator to use for the edit form |
||
275 | * @example 'getCMSValidator' |
||
276 | * |
||
277 | * @param File $file File context to generate validator from |
||
278 | * @return Validator Validator object |
||
279 | */ |
||
280 | public function getDMSFileEditValidator($file) |
||
299 | |||
300 | /** |
||
301 | * Set the folder name to store DMS files in |
||
302 | * |
||
303 | * @param string $folderName |
||
304 | * @return $this |
||
305 | */ |
||
306 | public function setFolderName($folderName) |
||
311 | |||
312 | /** |
||
313 | * Get the folder name for storing the document |
||
314 | * |
||
315 | * @return string |
||
316 | */ |
||
317 | public function getFolderName() |
||
321 | } |
||
322 |