phingofficial /
phing
| Total Complexity | 102 |
| Total Lines | 716 |
| Duplicated Lines | 0 % |
| Coverage | 77.82% |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like PhingTask 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 PhingTask, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 56 | class PhingTask extends Task |
||
| 57 | { |
||
| 58 | use FileSetAware; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * the target to call if any. |
||
| 62 | * |
||
| 63 | * @var Target |
||
| 64 | */ |
||
| 65 | protected $newTarget; |
||
| 66 | |||
| 67 | /** |
||
| 68 | * the basedir where is executed the build file. |
||
| 69 | * |
||
| 70 | * @var File |
||
| 71 | */ |
||
| 72 | private $dir; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * build.xml (can be absolute) in this case dir will be ignored. |
||
| 76 | */ |
||
| 77 | private $phingFile; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * should we inherit properties from the parent ? |
||
| 81 | */ |
||
| 82 | private $inheritAll = true; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * should we inherit references from the parent ? |
||
| 86 | */ |
||
| 87 | private $inheritRefs = false; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * the properties to pass to the new project. |
||
| 91 | */ |
||
| 92 | private $properties = []; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * the references to pass to the new project. |
||
| 96 | * |
||
| 97 | * @var PhingReference[] |
||
| 98 | */ |
||
| 99 | private $references = []; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * The temporary project created to run the build file. |
||
| 103 | * |
||
| 104 | * @var Project |
||
| 105 | */ |
||
| 106 | private $newProject; |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Fail the build process when the called build fails? |
||
| 110 | */ |
||
| 111 | private $haltOnFailure = false; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Whether the basedir of the new project should be the same one |
||
| 115 | * as it would be when running the build file directly - |
||
| 116 | * independent of dir and/or inheritAll settings. |
||
| 117 | */ |
||
| 118 | private $useNativeBasedir = false; |
||
| 119 | |||
| 120 | /** |
||
| 121 | * @var OutputStream |
||
| 122 | */ |
||
| 123 | private $out; |
||
| 124 | |||
| 125 | /** @var string */ |
||
| 126 | private $output; |
||
| 127 | |||
| 128 | /** |
||
| 129 | * @var array |
||
| 130 | */ |
||
| 131 | private $locals; |
||
| 132 | |||
| 133 | 40 | public function __construct(?Task $owner = null) |
|
| 134 | { |
||
| 135 | 40 | if (null !== $owner) { |
|
| 136 | 14 | $this->bindToOwner($owner); |
|
| 137 | } |
||
| 138 | 40 | parent::__construct(); |
|
| 139 | } |
||
| 140 | |||
| 141 | /** |
||
| 142 | * If true, abort the build process if there is a problem with or in the target build file. |
||
| 143 | * Defaults to false. |
||
| 144 | * |
||
| 145 | * @param bool $hof new value |
||
| 146 | */ |
||
| 147 | 18 | public function setHaltOnFailure($hof) |
|
| 148 | { |
||
| 149 | 18 | $this->haltOnFailure = (bool) $hof; |
|
| 150 | } |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Whether the basedir of the new project should be the same one |
||
| 154 | * as it would be when running the build file directly - |
||
| 155 | * independent of dir and/or inheritAll settings. |
||
| 156 | */ |
||
| 157 | public function setUseNativeBasedir(bool $b) |
||
| 158 | { |
||
| 159 | $this->useNativeBasedir = $b; |
||
| 160 | } |
||
| 161 | |||
| 162 | /** |
||
| 163 | * Creates a Project instance for the project to call. |
||
| 164 | */ |
||
| 165 | 40 | public function init() |
|
| 170 | } |
||
| 171 | |||
| 172 | /** |
||
| 173 | * Main entry point for the task. |
||
| 174 | */ |
||
| 175 | 37 | public function main() |
|
| 176 | { |
||
| 177 | // Call Phing on the file set with the attribute "phingfile" |
||
| 178 | 37 | if (null !== $this->phingFile || null !== $this->dir) { |
|
| 179 | 37 | $this->processFile(); |
|
| 180 | } |
||
| 181 | |||
| 182 | // if no filesets are given stop here; else process filesets |
||
| 183 | 31 | if (!empty($this->filesets)) { |
|
| 184 | // preserve old settings |
||
| 185 | $savedDir = $this->dir; |
||
| 186 | $savedPhingFile = $this->phingFile; |
||
| 187 | $savedTarget = $this->newTarget; |
||
| 188 | |||
| 189 | // set no specific target for files in filesets |
||
| 190 | // [HL] I'm commenting this out; I don't know why this should not be supported! |
||
| 191 | // $this->newTarget = null; |
||
| 192 | |||
| 193 | foreach ($this->filesets as $fs) { |
||
| 194 | $ds = $fs->getDirectoryScanner($this->project); |
||
| 195 | |||
| 196 | $fromDir = $fs->getDir($this->project); |
||
|
Unused Code
introduced
by
|
|||
| 197 | $srcFiles = $ds->getIncludedFiles(); |
||
| 198 | |||
| 199 | foreach ($srcFiles as $fname) { |
||
| 200 | $f = new File($ds->getbasedir(), $fname); |
||
| 201 | $f = $f->getAbsoluteFile(); |
||
| 202 | $this->phingFile = $f->getAbsolutePath(); |
||
| 203 | $this->dir = $f->getParentFile(); |
||
| 204 | $this->processFile(); // run Phing! |
||
| 205 | } |
||
| 206 | } |
||
| 207 | |||
| 208 | // side effect free programming ;-) |
||
| 209 | $this->dir = $savedDir; |
||
| 210 | $this->phingFile = $savedPhingFile; |
||
| 211 | $this->newTarget = $savedTarget; |
||
| 212 | |||
| 213 | // [HL] change back to correct dir |
||
| 214 | if (null !== $this->dir) { |
||
| 215 | chdir($this->dir->getAbsolutePath()); |
||
| 216 | } |
||
| 217 | } |
||
| 218 | |||
| 219 | // Remove any dangling references to help the GC |
||
| 220 | 31 | foreach ($this->properties as $property) { |
|
| 221 | 12 | $property->setFallback(null); |
|
| 222 | } |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * If true, pass all properties to the new phing project. |
||
| 227 | * Defaults to true. |
||
| 228 | * |
||
| 229 | * @param bool $inheritAll |
||
| 230 | */ |
||
| 231 | 21 | public function setInheritAll($inheritAll) |
|
| 232 | { |
||
| 233 | 21 | $this->inheritAll = (bool) $inheritAll; |
|
| 234 | } |
||
| 235 | |||
| 236 | /** |
||
| 237 | * If true, pass all references to the new phing project. |
||
| 238 | * Defaults to false. |
||
| 239 | * |
||
| 240 | * @param bool $inheritRefs |
||
| 241 | */ |
||
| 242 | 13 | public function setInheritRefs($inheritRefs) |
|
| 243 | { |
||
| 244 | 13 | $this->inheritRefs = (bool) $inheritRefs; |
|
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * The directory to use as a base directory for the new phing project. |
||
| 249 | * Defaults to the current project's basedir, unless inheritall |
||
| 250 | * has been set to false, in which case it doesn't have a default |
||
| 251 | * value. This will override the basedir setting of the called project. |
||
| 252 | */ |
||
| 253 | 14 | public function setDir(File $dir): void |
|
| 254 | { |
||
| 255 | 14 | $this->dir = $dir; |
|
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * The build file to use. |
||
| 260 | * Defaults to "build.xml". This file is expected to be a filename relative |
||
| 261 | * to the dir attribute given. |
||
| 262 | */ |
||
| 263 | 37 | public function setPhingFile(string $file) |
|
| 264 | { |
||
| 265 | // it is a string and not a file to handle relative/absolute |
||
| 266 | // otherwise a relative file will be resolved based on the current |
||
| 267 | // basedir. |
||
| 268 | 37 | $this->phingFile = $file; |
|
| 269 | } |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Alias function for setPhingfile. |
||
| 273 | * |
||
| 274 | * @param string $file |
||
| 275 | */ |
||
| 276 | 9 | public function setBuildfile($file) |
|
| 277 | { |
||
| 278 | 9 | $this->setPhingFile($file); |
|
| 279 | } |
||
| 280 | |||
| 281 | /** |
||
| 282 | * The target of the new Phing project to execute. |
||
| 283 | * Defaults to the new project's default target. |
||
| 284 | */ |
||
| 285 | 35 | public function setTarget(string $target) |
|
| 292 | } |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Set the filename to write the output to. This is relative to the value |
||
| 296 | * of the dir attribute if it has been set or to the base directory of the |
||
| 297 | * current project otherwise. |
||
| 298 | * |
||
| 299 | * @param string $outputFile the name of the file to which the output should go |
||
| 300 | */ |
||
| 301 | 1 | public function setOutput(string $outputFile): void |
|
| 304 | } |
||
| 305 | |||
| 306 | /** |
||
| 307 | * Property to pass to the new project. |
||
| 308 | * The property is passed as a 'user property'. |
||
| 309 | */ |
||
| 310 | 12 | public function createProperty() |
|
| 311 | { |
||
| 312 | 12 | $p = new PropertyTask(); |
|
| 313 | 12 | $p->setFallback($this->getNewProject()); |
|
| 314 | 12 | $p->setUserProperty(true); |
|
| 315 | 12 | $p->setTaskName('property'); |
|
| 316 | 12 | $this->properties[] = $p; |
|
| 317 | |||
| 318 | 12 | return $p; |
|
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Reference element identifying a data type to carry |
||
| 323 | * over to the new project. |
||
| 324 | */ |
||
| 325 | 2 | public function addReference(PhingReference $ref) |
|
| 326 | { |
||
| 327 | 2 | $this->references[] = $ref; |
|
| 328 | } |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Get the (sub)-Project instance currently in use. |
||
| 332 | */ |
||
| 333 | 37 | protected function getNewProject(): Project |
|
| 334 | { |
||
| 335 | 37 | if (null === $this->newProject) { |
|
| 336 | 6 | $this->reinit(); |
|
| 337 | } |
||
| 338 | |||
| 339 | 37 | return $this->newProject; |
|
| 340 | } |
||
| 341 | |||
| 342 | /** |
||
| 343 | * Called in execute or createProperty if newProject is null. |
||
| 344 | * |
||
| 345 | * <p>This can happen if the same instance of this task is run |
||
| 346 | * twice as newProject is set to null at the end of execute (to |
||
| 347 | * save memory and help the GC).</p> |
||
| 348 | * |
||
| 349 | * <p>Sets all properties that have been defined as nested |
||
| 350 | * property elements.</p> |
||
| 351 | */ |
||
| 352 | 6 | private function reinit() |
|
| 389 | } |
||
| 390 | } |
||
| 391 | } |
||
| 392 | |||
| 393 | /** |
||
| 394 | * Execute phing file. |
||
| 395 | * |
||
| 396 | * @throws BuildException |
||
| 397 | */ |
||
| 398 | 37 | private function processFile(): void |
|
| 399 | { |
||
| 400 | 37 | $buildFailed = false; |
|
| 401 | 37 | $buildFailedCause = null; |
|
| 402 | 37 | $savedDir = $this->dir; |
|
| 403 | 37 | $savedPhingFile = $this->phingFile; |
|
| 404 | 37 | $savedTarget = $this->newTarget; |
|
| 405 | |||
| 406 | 37 | $savedBasedirAbsPath = null; // this is used to save the basedir *if* we change it |
|
| 407 | |||
| 408 | try { |
||
| 409 | 37 | $this->getNewProject(); |
|
| 410 | |||
| 411 | 37 | $this->initializeProject(); |
|
| 412 | |||
| 413 | 37 | if (null !== $this->dir) { |
|
| 414 | 14 | if (!$this->useNativeBasedir) { |
|
| 415 | 14 | $this->newProject->setBasedir($this->dir); |
|
| 416 | 14 | if (null !== $savedDir) { // has been set explicitly |
|
| 417 | 14 | $this->newProject->setInheritedProperty('project.basedir', $this->dir->getAbsolutePath()); |
|
| 418 | } |
||
| 419 | } |
||
| 420 | } else { |
||
| 421 | // Since we're not changing the basedir here (for file resolution), |
||
| 422 | // we don't need to worry about any side-effects in this scanrio. |
||
| 423 | 24 | $this->dir = $this->getProject()->getBasedir(); |
|
| 424 | } |
||
| 425 | |||
| 426 | 37 | $this->overrideProperties(); |
|
| 427 | 37 | $this->phingFile = $this->phingFile ?? Phing::DEFAULT_BUILD_FILENAME; |
|
| 428 | |||
| 429 | 37 | $fu = new FileUtils(); |
|
| 430 | 37 | $file = $fu->resolveFile($this->dir, $this->phingFile); |
|
| 431 | 37 | $this->phingFile = $file->getAbsolutePath(); |
|
| 432 | 37 | $this->log('calling target(s) ' |
|
| 433 | 37 | . (empty($this->locals) ? '[default]' : implode(', ', $this->locals)) |
|
| 434 | 37 | . ' in build file ' . $this->phingFile, Project::MSG_VERBOSE); |
|
| 435 | |||
| 436 | 37 | $this->newProject->setUserProperty('phing.file', $this->phingFile); |
|
| 437 | |||
| 438 | 37 | if (empty($this->locals)) { |
|
| 439 | 37 | $defaultTarget = $this->newProject->getDefaultTarget(); |
|
| 440 | 37 | if (!empty($defaultTarget)) { |
|
| 441 | 37 | $this->locals[] = $defaultTarget; |
|
| 442 | } |
||
| 443 | } |
||
| 444 | |||
| 445 | 37 | $thisPhingFile = $this->getProject()->getProperty('phing.file'); |
|
| 446 | // Are we trying to call the target in which we are defined (or |
||
| 447 | // the build file if this is a top level task)? |
||
| 448 | if ( |
||
| 449 | 37 | null !== $thisPhingFile |
|
| 450 | 37 | && null !== $this->getOwningTarget() |
|
| 451 | 37 | && $thisPhingFile === $file->getPath() |
|
| 452 | 37 | && '' === $this->getOwningTarget()->getName() |
|
| 453 | ) { |
||
| 454 | if ('phingcall' === $this->getTaskName()) { |
||
| 455 | throw new BuildException('phingcall must not be used at the top level.'); |
||
| 456 | } |
||
| 457 | |||
| 458 | throw new BuildException( |
||
| 459 | sprintf( |
||
| 460 | '%s task at the top level must not invoke its own build file.', |
||
| 461 | $this->getTaskName() |
||
| 462 | ) |
||
| 463 | ); |
||
| 464 | } |
||
| 465 | |||
| 466 | 37 | ProjectConfigurator::configureProject($this->newProject, new File($this->phingFile)); |
|
| 467 | |||
| 468 | 33 | if (null === $this->newTarget) { |
|
| 469 | 3 | $this->newTarget = $this->newProject->getDefaultTarget(); |
|
| 470 | } |
||
| 471 | |||
| 472 | // Are we trying to call the target in which we are defined? |
||
| 473 | if ( |
||
| 474 | 33 | $this->newProject->getBasedir()->equals($this->project->getBasedir()) |
|
| 475 | 33 | && $this->newProject->getProperty('phing.file') === $this->project->getProperty('phing.file') |
|
| 476 | 33 | && null !== $this->getOwningTarget() |
|
| 477 | ) { |
||
| 478 | 19 | $owningTargetName = $this->getOwningTarget()->getName(); |
|
| 479 | 19 | if ($this->newTarget === $owningTargetName) { |
|
| 480 | 2 | throw new BuildException( |
|
| 481 | 2 | sprintf( |
|
| 482 | 2 | '%s task calling its own parent target', |
|
| 483 | 2 | $this->getTaskName() |
|
| 484 | 2 | ) |
|
| 485 | 2 | ); |
|
| 486 | } |
||
| 487 | |||
| 488 | 17 | $targets = $this->getProject()->getTargets(); |
|
| 489 | 17 | $taskName = $this->getTaskName(); |
|
| 490 | |||
| 491 | 17 | foreach ($this->locals as $local) { |
|
| 492 | 17 | if (isset($targets[$local])) { |
|
| 493 | 9 | if ($targets[$local]->dependsOn($owningTargetName)) { |
|
| 494 | throw new BuildException( |
||
| 495 | sprintf( |
||
| 496 | "%s task calling a target that depends on its parent target '%s'.", |
||
| 497 | $taskName, |
||
| 498 | $owningTargetName |
||
| 499 | ) |
||
| 500 | ); |
||
| 501 | } |
||
| 502 | } |
||
| 503 | } |
||
| 504 | } |
||
| 505 | |||
| 506 | 31 | $this->addReferences(); |
|
| 507 | 31 | $this->newProject->executeTarget($this->newTarget); |
|
| 508 | 9 | } catch (Exception $e) { |
|
| 509 | 9 | $buildFailed = true; |
|
| 510 | 9 | $buildFailedCause = $e; |
|
| 511 | 9 | $this->log('[' . get_class($e) . '] ' . $e->getMessage(), Project::MSG_ERR); |
|
| 512 | 9 | if (Phing::getMsgOutputLevel() <= Project::MSG_DEBUG) { |
|
| 513 | 9 | $lines = explode("\n", $e->getTraceAsString()); |
|
| 514 | 9 | foreach ($lines as $line) { |
|
| 515 | 9 | $this->log($line, Project::MSG_DEBUG); |
|
| 516 | } |
||
| 517 | } |
||
| 518 | } finally { |
||
| 519 | // reset environment values to prevent side-effects. |
||
| 520 | |||
| 521 | 37 | $this->newProject = null; |
|
| 522 | 37 | $pkeys = array_keys($this->properties); |
|
| 523 | 37 | foreach ($pkeys as $k) { |
|
| 524 | 12 | $this->properties[$k]->setProject(null); |
|
| 525 | } |
||
| 526 | |||
| 527 | 37 | if (null !== $this->output && null !== $this->out) { |
|
| 528 | 1 | $this->out->close(); |
|
| 529 | } |
||
| 530 | |||
| 531 | 37 | $this->dir = $savedDir; |
|
| 532 | 37 | $this->phingFile = $savedPhingFile; |
|
| 533 | 37 | $this->newTarget = $savedTarget; |
|
| 534 | |||
| 535 | // If the basedir for any project was changed, we need to set that back here. |
||
| 536 | 37 | if (null !== $savedBasedirAbsPath) { |
|
| 537 | chdir($savedBasedirAbsPath); |
||
| 538 | } |
||
| 539 | |||
| 540 | 37 | if ($this->haltOnFailure && $buildFailed) { |
|
| 541 | 37 | throw new BuildException('Execution of the target buildfile failed. Aborting.', $buildFailedCause); |
|
| 542 | } |
||
| 543 | } |
||
| 544 | } |
||
| 545 | |||
| 546 | /** |
||
| 547 | * Configure the Project, i.e. make intance, attach build listeners |
||
| 548 | * (copy from father project), add Task and Datatype definitions, |
||
| 549 | * copy properties and references from old project if these options |
||
| 550 | * are set via the attributes of the XML tag. |
||
| 551 | * |
||
| 552 | * Developer note: |
||
| 553 | * This function replaces the old methods "init", "_reinit" and |
||
| 554 | * "_initializeProject". |
||
| 555 | */ |
||
| 556 | 37 | private function initializeProject() |
|
| 557 | { |
||
| 558 | 37 | $this->newProject->setInputHandler($this->project->getInputHandler()); |
|
| 559 | |||
| 560 | 37 | foreach ($this->project->getBuildListeners() as $listener) { |
|
| 561 | 37 | $this->newProject->addBuildListener($listener); |
|
| 562 | } |
||
| 563 | |||
| 564 | /* Copy things from old project. Datatypes and Tasks are always |
||
| 565 | * copied, properties and references only if specified so/not |
||
| 566 | * specified otherwise in the XML definition. |
||
| 567 | */ |
||
| 568 | // Add Datatype definitions |
||
| 569 | 37 | foreach ($this->project->getDataTypeDefinitions() as $typeName => $typeClass) { |
|
| 570 | 37 | $this->newProject->addDataTypeDefinition($typeName, $typeClass); |
|
| 571 | } |
||
| 572 | |||
| 573 | // Add Task definitions |
||
| 574 | 37 | foreach ($this->project->getTaskDefinitions() as $taskName => $taskClass) { |
|
| 575 | 37 | if ('Phing\Task\System\PropertyTask' === $taskClass) { |
|
| 576 | // we have already added this taskdef in init() |
||
| 577 | 37 | continue; |
|
| 578 | } |
||
| 579 | 37 | $this->newProject->addTaskDefinition($taskName, $taskClass); |
|
| 580 | } |
||
| 581 | |||
| 582 | 37 | if (null !== $this->output) { |
|
| 583 | try { |
||
| 584 | 1 | if (null !== $this->dir) { |
|
| 585 | 1 | $outfile = (new FileUtils())->resolveFile($this->dir, $this->output); |
|
| 586 | } else { |
||
| 587 | 1 | $outfile = $this->getProject()->resolveFile($this->output); |
|
| 588 | } |
||
| 589 | 1 | $this->out = new FileOutputStream($outfile); |
|
| 590 | 1 | $logger = new DefaultLogger(); |
|
| 591 | 1 | $logger->setMessageOutputLevel(Project::MSG_INFO); |
|
| 592 | 1 | $logger->setOutputStream($this->out); |
|
| 593 | 1 | $logger->setErrorStream($this->out); |
|
| 594 | 1 | $this->newProject->addBuildListener($logger); |
|
| 595 | } catch (Exception $ex) { |
||
| 596 | $this->log("Phing: Can't set output to " . $this->output); |
||
| 597 | } |
||
| 598 | } |
||
| 599 | |||
| 600 | 37 | if ($this->useNativeBasedir) { |
|
| 601 | $this->addAlmostAll($this->getProject()->getUserProperties(), 'user'); |
||
| 602 | } else { |
||
| 603 | 37 | $this->project->copyUserProperties($this->newProject); |
|
| 604 | } |
||
| 605 | |||
| 606 | 37 | if (!$this->inheritAll) { |
|
| 607 | // set System built-in properties separately, |
||
| 608 | // b/c we won't inherit them. |
||
| 609 | 13 | $this->newProject->setSystemProperties(); |
|
| 610 | } else { |
||
| 611 | 25 | $this->addAlmostAll($this->getProject()->getProperties(), 'plain'); |
|
| 612 | } |
||
| 613 | } |
||
| 614 | |||
| 615 | /** |
||
| 616 | * Copies all properties from the given table to the new project - |
||
| 617 | * omitting those that have already been set in the new project as |
||
| 618 | * well as properties named basedir or phing.file. |
||
| 619 | * |
||
| 620 | * @param array $props properties <code>Hashtable</code> to copy to the |
||
| 621 | * new project |
||
| 622 | * @param string $type the type of property to set (a plain Phing property, a |
||
| 623 | * user property or an inherited property) |
||
| 624 | */ |
||
| 625 | 25 | private function addAlmostAll(array $props, string $type): void |
|
| 642 | } |
||
| 643 | } |
||
| 644 | } |
||
| 645 | |||
| 646 | /** |
||
| 647 | * Override the properties in the new project with the one |
||
| 648 | * explicitly defined as nested elements here. |
||
| 649 | * |
||
| 650 | * @throws BuildException |
||
| 651 | */ |
||
| 652 | 37 | private function overrideProperties() |
|
| 672 | } |
||
| 673 | } |
||
| 674 | |||
| 675 | /** |
||
| 676 | * Add the references explicitly defined as nested elements to the |
||
| 677 | * new project. Also copy over all references that don't override |
||
| 678 | * existing references in the new project if inheritrefs has been |
||
| 679 | * requested. |
||
| 680 | * |
||
| 681 | * @throws BuildException |
||
| 682 | */ |
||
| 683 | 31 | private function addReferences() |
|
| 684 | { |
||
| 685 | // parent project references |
||
| 686 | 31 | $projReferences = $this->project->getReferences(); |
|
| 687 | |||
| 688 | 31 | $newReferences = $this->newProject->getReferences(); |
|
| 689 | |||
| 690 | 31 | $subprojRefKeys = []; |
|
| 691 | |||
| 692 | 31 | if (count($this->references) > 0) { |
|
| 693 | 1 | for ($i = 0, $count = count($this->references); $i < $count; ++$i) { |
|
| 694 | 1 | $ref = $this->references[$i]; |
|
| 695 | 1 | $refid = $ref->getRefId(); |
|
| 696 | |||
| 697 | 1 | if (null === $refid) { |
|
| 698 | throw new BuildException('the refid attribute is required for reference elements'); |
||
| 699 | } |
||
| 700 | 1 | if (!isset($projReferences[$refid])) { |
|
| 701 | $this->log("Parent project doesn't contain any reference '" . $refid . "'", Project::MSG_WARN); |
||
| 702 | |||
| 703 | continue; |
||
| 704 | } |
||
| 705 | |||
| 706 | 1 | $subprojRefKeys[] = $refid; |
|
| 707 | 1 | unset($this->references[$i]); //thisReferences.remove(refid); |
|
| 708 | 1 | $toRefid = $ref->getToRefid(); |
|
| 709 | 1 | if (null === $toRefid) { |
|
| 710 | 1 | $toRefid = $refid; |
|
| 711 | } |
||
| 712 | 1 | $this->copyReference($refid, $toRefid); |
|
| 713 | } |
||
| 714 | } |
||
| 715 | |||
| 716 | // Now add all references that are not defined in the |
||
| 717 | // subproject, if inheritRefs is true |
||
| 718 | 31 | if ($this->inheritRefs) { |
|
| 719 | // get the keys that are were not used by the subproject |
||
| 720 | 2 | $unusedRefKeys = array_diff(array_keys($projReferences), $subprojRefKeys); |
|
| 721 | |||
| 722 | 2 | foreach ($unusedRefKeys as $key) { |
|
| 723 | 2 | if (isset($newReferences[$key])) { |
|
| 724 | 2 | continue; |
|
| 725 | } |
||
| 726 | 2 | $this->copyReference($key, $key); |
|
| 727 | } |
||
| 728 | } |
||
| 729 | } |
||
| 730 | |||
| 731 | /** |
||
| 732 | * Try to clone and reconfigure the object referenced by oldkey in |
||
| 733 | * the parent project and add it to the new project with the key |
||
| 734 | * newkey. |
||
| 735 | * |
||
| 736 | * <p>If we cannot clone it, copy the referenced object itself and |
||
| 737 | * keep our fingers crossed.</p> |
||
| 738 | * |
||
| 739 | * @param string $oldKey |
||
| 740 | * @param string $newKey |
||
| 741 | * |
||
| 742 | * @throws BuildException |
||
| 743 | */ |
||
| 744 | 3 | private function copyReference($oldKey, $newKey) |
|
| 772 | } |
||
| 773 | } |
||
| 774 |
Loading history...
