File: ImportTask.php

package info (click to toggle)
phing 2.8.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,764 kB
  • ctags: 10,110
  • sloc: php: 32,188; xml: 537; makefile: 16; sh: 5
file content (125 lines) | stat: -rwxr-xr-x 4,013 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?php
/*
 *  $Id: 1e492db618e6bdf0abcf83b4029174125863fc96 $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

require_once 'phing/Task.php';
require_once 'phing/system/io/FileSystem.php';
require_once 'phing/system/io/PhingFile.php';
require_once 'phing/parser/ProjectConfigurator.php';

/**
 * Imports another build file into the current project.
 *
 * Targets and properties of the imported file can be overrridden 
 * by targets and properties of the same name declared in the importing file. 
 *
 * The imported file will have a new synthetic property of 
 * "phing.file.<projectname>" declared which gives the full path to the 
 * imported file. Additionally each target in the imported file will be 
 * declared twice: once with the normal name and once with "<projectname>." 
 * prepended. The "<projectname>.<targetname>" synthetic targets allow the 
 * importing file a mechanism to call the imported files targets as 
 * dependencies or via the <phing> or <phingcall> task mechanisms.
 *
 * @author Bryan Davis <bpd@keynetics.com>
 * @version $Id: 1e492db618e6bdf0abcf83b4029174125863fc96 $
 * @package phing.tasks.system
 */
class ImportTask extends Task {

  /**
   * @var FileSystem
   */
  protected $fs;

  /**
   * @var PhingFile
   */
  protected $file = null;

  /**
   * @var bool
   */
  protected $optional = false;

  /**
   * Initialize task.
   * @return void
   */
  public function init () {
    $this->fs = FileSystem::getFileSystem();
  } //end init


  /**
   * Set the file to import.
   * @param string $f Path to file
   * @return void
   */
  public function setFile ($f) {
    $this->file = $f;
  }

  /**
   * Is this include optional?
   * @param bool $opt If true, do not stop the build if the file does not 
   * exist
   * @return void
   */
  public function setOptional ($opt) {
    $this->optional = $opt;
  }

  /**
   * Parse a Phing build file and copy the properties, tasks, data types and 
   * targets it defines into the current project.
   *
   * @return void
   */
  public function main () {
    if (!isset($this->file)) {
      throw new BuildException("Missing attribute 'file'");
    }

    $file = new PhingFile($this->file);
    if (!$file->isAbsolute()) {
      $file = new PhingFile($this->project->getBasedir(), $this->file);
    }
    if (!$file->exists()) {
      $msg = "Unable to find build file: {$file->getPath()}";
      if ($this->optional) {
        $this->log($msg . '... skipped');
        return;
      } else {
        throw new BuildException($msg);
      }
    }

    $ctx = $this->project->getReference("phing.parsing.context");
    $cfg = $ctx->getConfigurator();
    // Import xml file into current project scope
    // Since this is delayed until after the importing file has been 
    // processed, the properties and targets of this new file may not take 
    // effect if they have alreday been defined in the outer scope.
    $this->log("Importing file from {$file->getAbsolutePath()}", Project::MSG_VERBOSE);
    ProjectConfigurator::configureProject($this->project, $file);
  } //end main

} //end ImportTask