chamilo /
chamilo-lms
| Total Complexity | 56 |
| Total Lines | 391 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like SequenceResourceRepository 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.
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 SequenceResourceRepository, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class SequenceResourceRepository extends EntityRepository |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * Find the SequenceResource based in the resourceId and type. |
||
| 21 | * |
||
| 22 | * @param int $resourceId |
||
| 23 | * @param int $type |
||
| 24 | * |
||
| 25 | * @return SequenceResource |
||
| 26 | */ |
||
| 27 | public function findRequirementForResource($resourceId, $type) |
||
| 30 | } |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @todo implement for all types only work for sessions |
||
| 34 | * |
||
| 35 | * @param int $resourceId |
||
| 36 | * @param int $type |
||
| 37 | * |
||
| 38 | * @return array |
||
| 39 | */ |
||
| 40 | public function getRequirementAndDependencies($resourceId, $type) |
||
| 41 | { |
||
| 42 | $sequence = $this->findRequirementForResource($resourceId, $type); |
||
| 43 | $result = ['requirements' => [], 'dependencies' => []]; |
||
| 44 | if ($sequence && $sequence->hasGraph()) { |
||
| 45 | $graph = $sequence->getSequence()->getUnSerializeGraph(); |
||
| 46 | $vertex = $graph->getVertex($resourceId); |
||
| 47 | $from = $vertex->getVerticesEdgeFrom(); |
||
| 48 | |||
| 49 | foreach ($from as $subVertex) { |
||
| 50 | $vertexId = $subVertex->getId(); |
||
| 51 | $sessionInfo = api_get_session_info($vertexId); |
||
| 52 | $sessionInfo['admin_link'] = '<a href="'.\SessionManager::getAdminPath($vertexId).'">'.$sessionInfo['name'].'</a>'; |
||
|
Bug
introduced
by
|
|||
| 53 | $result['requirements'][] = $sessionInfo; |
||
| 54 | } |
||
| 55 | |||
| 56 | $to = $vertex->getVerticesEdgeTo(); |
||
| 57 | foreach ($to as $subVertex) { |
||
| 58 | $vertexId = $subVertex->getId(); |
||
| 59 | $sessionInfo = api_get_session_info($vertexId); |
||
| 60 | $sessionInfo['admin_link'] = '<a href="'.\SessionManager::getAdminPath($vertexId).'">'.$sessionInfo['name'].'</a>'; |
||
| 61 | $result['dependencies'][] = $sessionInfo; |
||
| 62 | } |
||
| 63 | } |
||
| 64 | |||
| 65 | return $result; |
||
| 66 | } |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Deletes a node and check in all the dependencies if the node exists in |
||
| 70 | * order to deleted. |
||
| 71 | * |
||
| 72 | * @param int $resourceId |
||
| 73 | * @param int $type |
||
| 74 | */ |
||
| 75 | public function deleteResource($resourceId, $type) |
||
| 76 | { |
||
| 77 | $sequence = $this->findRequirementForResource($resourceId, $type); |
||
| 78 | if ($sequence && $sequence->hasGraph()) { |
||
| 79 | $em = $this->getEntityManager(); |
||
| 80 | $graph = $sequence->getSequence()->getUnSerializeGraph(); |
||
| 81 | $mainVertex = $graph->getVertex($resourceId); |
||
| 82 | $vertices = $graph->getVertices(); |
||
| 83 | |||
| 84 | /** @var Vertex $vertex */ |
||
| 85 | foreach ($vertices as $vertex) { |
||
| 86 | $subResourceId = $vertex->getId(); |
||
| 87 | $subSequence = $this->findRequirementForResource($subResourceId, $type); |
||
| 88 | if ($sequence && $subSequence->hasGraph()) { |
||
| 89 | $graph = $subSequence->getSequence()->getUnSerializeGraph(); |
||
| 90 | $subMainVertex = $graph->getVertex($resourceId); |
||
| 91 | $subMainVertex->destroy(); |
||
| 92 | $subSequence->getSequence()->setGraphAndSerialize($graph); |
||
| 93 | $em->persist($subSequence); |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | $mainVertex->destroy(); |
||
| 98 | $em->remove($sequence); |
||
| 99 | $em->flush(); |
||
| 100 | } |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Get the requirements for a resource only. |
||
| 105 | * |
||
| 106 | * @param int $resourceId The resource ID |
||
| 107 | * @param int $type The type of sequence resource |
||
| 108 | * |
||
| 109 | * @return array |
||
| 110 | */ |
||
| 111 | public function getRequirements($resourceId, $type) |
||
| 159 | } |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Get the requirements and dependencies within a sequence for a resource. |
||
| 163 | * |
||
| 164 | * @param int $resourceId The resource ID |
||
| 165 | * @param int $type The type of sequence resource |
||
| 166 | * |
||
| 167 | * @return array |
||
| 168 | */ |
||
| 169 | public function getRequirementsAndDependenciesWithinSequences($resourceId, $type) |
||
| 170 | { |
||
| 171 | $sequencesResource = $this->findBy([ |
||
| 172 | 'resourceId' => $resourceId, |
||
| 173 | 'type' => $type, |
||
| 174 | ]); |
||
| 175 | |||
| 176 | $result = []; |
||
| 177 | |||
| 178 | /** @var SequenceResource $sequenceResource */ |
||
| 179 | foreach ($sequencesResource as $sequenceResource) { |
||
| 180 | if (!$sequenceResource->hasGraph()) { |
||
| 181 | continue; |
||
| 182 | } |
||
| 183 | |||
| 184 | $sequence = $sequenceResource->getSequence(); |
||
| 185 | $graph = $sequence->getUnSerializeGraph(); |
||
| 186 | $vertex = $graph->getVertex($resourceId); |
||
| 187 | $from = $vertex->getVerticesEdgeFrom(); |
||
| 188 | $to = $vertex->getVerticesEdgeTo(); |
||
| 189 | |||
| 190 | $requirements = $this->findVerticesEdges($from, $type); |
||
| 191 | $dependencies = $this->findVerticesEdges($to, $type); |
||
| 192 | |||
| 193 | $result[$sequence->getId()] = [ |
||
| 194 | 'name' => $sequence->getName(), |
||
| 195 | 'requirements' => $requirements, |
||
| 196 | 'dependencies' => $dependencies, |
||
| 197 | ]; |
||
| 198 | } |
||
| 199 | |||
| 200 | return $result; |
||
| 201 | } |
||
| 202 | |||
| 203 | /** |
||
| 204 | * Check if the ser has completed the requirements for the sequences. |
||
| 205 | * |
||
| 206 | * @param array $sequences The sequences |
||
| 207 | * @param int $type The type of sequence resource |
||
| 208 | * @param int $userId |
||
| 209 | * @param int $sessionId |
||
| 210 | * |
||
| 211 | * @return array |
||
| 212 | */ |
||
| 213 | public function checkRequirementsForUser(array $sequences, $type, $userId, $sessionId = 0) |
||
| 214 | { |
||
| 215 | $sequenceList = []; |
||
| 216 | $em = $this->getEntityManager(); |
||
| 217 | $gradebookCategoryRepo = $em->getRepository('ChamiloCoreBundle:GradebookCategory'); |
||
| 218 | |||
| 219 | $sessionUserList = []; |
||
| 220 | if (SequenceResource::COURSE_TYPE == $type) { |
||
| 221 | $checkOnlySameSession = api_get_configuration_value('course_sequence_valid_only_in_same_session'); |
||
| 222 | if ($checkOnlySameSession) { |
||
| 223 | $sessionUserList = [$sessionId]; |
||
| 224 | } else { |
||
| 225 | $criteria = ['user' => $userId]; |
||
| 226 | $sessions = $em->getRepository('ChamiloCoreBundle:SessionRelUser')->findBy($criteria); |
||
| 227 | if ($sessions) { |
||
| 228 | /** @var SessionRelUser $sessionRelUser */ |
||
| 229 | foreach ($sessions as $sessionRelUser) { |
||
| 230 | $sessionUserList[] = $sessionRelUser->getSession()->getId(); |
||
| 231 | } |
||
| 232 | } |
||
| 233 | } |
||
| 234 | } |
||
| 235 | |||
| 236 | foreach ($sequences as $sequenceId => $sequence) { |
||
| 237 | $item = [ |
||
| 238 | 'name' => $sequence['name'], |
||
| 239 | 'requirements' => [], |
||
| 240 | ]; |
||
| 241 | $resourceItem = null; |
||
| 242 | |||
| 243 | foreach ($sequence['requirements'] as $resource) { |
||
| 244 | switch ($type) { |
||
| 245 | case SequenceResource::SESSION_TYPE: |
||
| 246 | $id = $resource->getId(); |
||
| 247 | $resourceItem = [ |
||
| 248 | 'name' => $resource->getName(), |
||
| 249 | 'status' => true, |
||
| 250 | ]; |
||
| 251 | |||
| 252 | $sessionsCourses = $resource->getCourses(); |
||
| 253 | foreach ($sessionsCourses as $sessionCourse) { |
||
| 254 | $course = $sessionCourse->getCourse(); |
||
| 255 | $gradebooks = $gradebookCategoryRepo->findBy( |
||
| 256 | [ |
||
| 257 | 'courseCode' => $course->getCode(), |
||
| 258 | 'sessionId' => $resource->getId(), |
||
| 259 | 'isRequirement' => true, |
||
| 260 | ] |
||
| 261 | ); |
||
| 262 | |||
| 263 | foreach ($gradebooks as $gradebook) { |
||
| 264 | $category = \Category::createCategoryObjectFromEntity($gradebook); |
||
| 265 | if (!empty($userId)) { |
||
| 266 | $resourceItem['status'] = $resourceItem['status'] && \Category::userFinishedCourse( |
||
| 267 | $userId, |
||
| 268 | $category |
||
| 269 | ); |
||
| 270 | } |
||
| 271 | } |
||
| 272 | } |
||
| 273 | break; |
||
| 274 | case SequenceResource::COURSE_TYPE: |
||
| 275 | $id = $resource->getId(); |
||
| 276 | $status = $this->checkCourseRequirements($userId, $resource, 0); |
||
| 277 | |||
| 278 | if (false === $status) { |
||
| 279 | $sessionsInCourse = \SessionManager::get_session_by_course($id); |
||
| 280 | foreach ($sessionsInCourse as $session) { |
||
| 281 | if (in_array($session['id'], $sessionUserList)) { |
||
| 282 | $status = $this->checkCourseRequirements($userId, $resource, $session['id']); |
||
| 283 | if (true === $status) { |
||
| 284 | break; |
||
| 285 | } |
||
| 286 | } |
||
| 287 | } |
||
| 288 | } |
||
| 289 | |||
| 290 | $resourceItem = [ |
||
| 291 | 'name' => $resource->getTitle(), |
||
| 292 | 'status' => $status, |
||
| 293 | ]; |
||
| 294 | |||
| 295 | break; |
||
| 296 | } |
||
| 297 | |||
| 298 | if (empty($id)) { |
||
| 299 | continue; |
||
| 300 | } |
||
| 301 | |||
| 302 | $item['requirements'][$id] = $resourceItem; |
||
| 303 | } |
||
| 304 | $sequenceList[$sequenceId] = $item; |
||
| 305 | } |
||
| 306 | |||
| 307 | return $sequenceList; |
||
| 308 | } |
||
| 309 | |||
| 310 | public function checkCourseRequirements($userId, Course $course, $sessionId) |
||
| 350 | } |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Check if at least one sequence are completed. |
||
| 354 | * |
||
| 355 | * @param array $sequences The sequences |
||
| 356 | * |
||
| 357 | * @return bool |
||
| 358 | */ |
||
| 359 | public function checkSequenceAreCompleted(array $sequences) |
||
| 374 | } |
||
| 375 | |||
| 376 | /** |
||
| 377 | * Get sessions from vertices. |
||
| 378 | * |
||
| 379 | * @param Vertices $verticesEdges The vertices |
||
| 380 | * @param int $type |
||
| 381 | * |
||
| 382 | * @return array |
||
| 383 | */ |
||
| 384 | protected function findVerticesEdges(Vertices $verticesEdges, $type) |
||
| 408 | } |
||
| 409 | } |
||
| 410 |
Loading history...