ProjectComponent.php 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?php
  2. /*
  3. * $Id: ProjectComponent.php 905 2010-10-05 16:28:03Z mrook $
  4. *
  5. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  6. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  7. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  8. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  9. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16. *
  17. * This software consists of voluntary contributions made by many individuals
  18. * and is licensed under the LGPL. For more information please see
  19. * <http://phing.info>.
  20. */
  21. /**
  22. * Abstract class providing properties and methods common to all
  23. * the project components
  24. *
  25. * @author Andreas Aderhold <andi@binarycloud.com>
  26. * @author Hans Lellelid <hans@xmpl.org>
  27. * @version $Revision: 905 $
  28. * @package phing
  29. */
  30. abstract class ProjectComponent {
  31. /**
  32. * Holds a reference to the project that a project component
  33. * (a task, a target, etc.) belongs to
  34. *
  35. * @var Project A reference to the current project instance
  36. */
  37. protected $project = null;
  38. /**
  39. * References the project to the current component.
  40. *
  41. * @param Project $project The reference to the current project
  42. */
  43. public function setProject($project) {
  44. $this->project = $project;
  45. }
  46. /**
  47. * Returns a reference to current project
  48. *
  49. * @return Project Reference to current porject object
  50. */
  51. public function getProject() {
  52. return $this->project;
  53. }
  54. /**
  55. * Logs a message with the given priority.
  56. *
  57. * @param string $msg The message to be logged.
  58. * @param integer $level The message's priority at this message should have
  59. */
  60. public function log($msg, $level = Project::MSG_INFO) {
  61. if ($this->project !== null) {
  62. $this->project->log($msg, $level);
  63. }
  64. }
  65. }