Changeset 173

Show
Ignore:
Timestamp:
03/12/07 20:34:30 (2 years ago)
Author:
hans
Message:

Cleanup phpdoc & method access levels

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/classes/phing/BuildEvent.php

    r144 r173  
    4444 
    4545    /** 
    46      * A reference to the project 
    47      * @var Project 
     46     * A reference to the project 
     47     * @var Project 
    4848     */ 
    4949    protected $project; 
    5050 
    5151    /** 
    52      * A reference to the target 
    53      * @var Target 
     52     * A reference to the target 
     53     * @var Target 
    5454     */ 
    5555    protected $target; 
    5656 
    5757    /** 
    58      * A reference to the task 
     58     * A reference to the task 
    5959     * 
    60      * @var Task 
     60     * @var Task 
    6161     */ 
    6262    protected $task; 
    6363 
    6464    /** 
    65      *  The message of this event, if the event is a message 
    66      *  @var    string 
    67      *  @access private 
     65     * The message of this event, if the event is a message 
     66     * @var string 
    6867     */ 
    6968    protected $message = null; 
    7069 
    7170    /** 
    72      * The priority of the message 
     71     * The priority of the message 
    7372     * 
    74      *  @var    string 
    75      *  @see    $message 
    76      *  @access private 
     73     * @var    string 
     74     * @see    $message 
    7775     */ 
    7876    protected $priority = Project::MSG_VERBOSE; 
    7977 
    8078    /** 
    81      * The execption that caused the event, if any 
     79     * The execption that caused the event, if any 
    8280     * 
    83      *  @var    object 
    84      *  @access private 
     81     * @var    object 
    8582     */ 
    8683    protected $exception = null; 
    8784 
    8885    /** 
    89      * Construct a BuildEvent for a project, task or target source event 
     86     * Construct a BuildEvent for a project, task or target source event 
    9087     * 
    91      *  @param  object  project the project that emitted the event. 
    92      *  @access public 
     88     * @param  object  project the project that emitted the event. 
    9389     */ 
    94     function __construct($source) { 
     90    public function __construct($source) { 
    9591        parent::__construct($source); 
    9692        if ($source instanceof Project) { 
    …… 
    112108 
    113109    /** 
    114      * Sets the message with details and the message priority for this event. 
     110     * Sets the message with details and the message priority for this event. 
    115111     * 
    116      * @param  string   The string message of the event 
    117      * @param  integer  The priority this message should have 
     112     * @param  string   The string message of the event 
     113     * @param  integer  The priority this message should have 
    118114     */ 
    119     function setMessage($message, $priority) { 
     115    public function setMessage($message, $priority) { 
    120116        $this->message = (string) $message; 
    121117        $this->priority = (int) $priority; 
    …… 
    123119 
    124120    /** 
    125      * Set the exception that was the cause of this event. 
     121     * Set the exception that was the cause of this event. 
    126122     * 
    127      * @param  Exception The exception that caused the event 
     123     * @param  Exception The exception that caused the event 
    128124     */ 
    129     function setException($exception) { 
     125    public function setException($exception) { 
    130126        $this->exception = $exception; 
    131127    } 
    132128 
    133129    /** 
    134      * Returns the project instance that fired this event. 
     130     * Returns the project instance that fired this event. 
    135131     * 
    136      * The reference to the project instance is set by the constructor if this 
    137      * event was fired from the project class. 
     132     * The reference to the project instance is set by the constructor if this 
     133     * event was fired from the project class. 
    138134     * 
    139      * @return  Project  The project instance that fired this event 
     135     * @return  Project  The project instance that fired this event 
    140136     */ 
    141     function getProject() { 
     137    public function getProject() { 
    142138        return $this->project; 
    143139    } 
    144140 
    145141    /** 
    146      * Returns the target instance that fired this event. 
     142     * Returns the target instance that fired this event. 
    147143     * 
    148      * The reference to the target instance is set by the constructor if this 
    149      * event was fired from the target class. 
     144     * The reference to the target instance is set by the constructor if this 
     145     * event was fired from the target class. 
    150146     * 
    151      *  @return  object  The target that fired this event 
    152      *  @access  public 
     147     * @return Target The target that fired this event 
    153148     */ 
    154     function getTarget() { 
     149    public function getTarget() { 
    155150        return $this->target; 
    156151    } 
    157152 
    158153    /** 
    159      * Returns the target instance that fired this event. 
     154     * Returns the target instance that fired this event. 
    160155     * 
    161      * The reference to the task instance is set by the constructor if this 
    162      * event was fired within a task. 
     156     * The reference to the task instance is set by the constructor if this 
     157     * event was fired within a task. 
    163158     * 
    164      *  @return  object  The task that fired this event 
    165      *  @access  public 
     159     * @return Task The task that fired this event 
    166160     */ 
    167     function getTask() { 
     161    public function getTask() { 
    168162        return $this->task; 
    169163    } 
    170164 
    171165    /** 
    172      * Returns the logging message. This field will only be set for 
    173      * "messageLogged" events. 
     166     * Returns the logging message. This field will only be set for 
     167     * "messageLogged" events. 
    174168     * 
    175      *  @return  string   The log message 
    176      *  @access  public 
     169     * @return string The log message 
    177170     */ 
    178171    function getMessage() { 
    …… 
    181174 
    182175    /** 
    183      * Returns the priority of the logging message. This field will only 
    184      * be set for "messageLogged" events. 
     176     * Returns the priority of the logging message. This field will only 
     177     * be set for "messageLogged" events. 
    185178     * 
    186      *  @return  integer  The message priority 
    187      *  @access  public 
     179     * @return integer The message priority 
    188180     */ 
    189181    function getPriority() { 
    …… 
    192184 
    193185    /** 
    194      * Returns the exception that was thrown, if any. 
    195      * This field will only be set for "taskFinished", "targetFinished", and 
    196      * "buildFinished" events. 
     186     * Returns the exception that was thrown, if any. 
     187     * This field will only be set for "taskFinished", "targetFinished", and 
     188     * "buildFinished" events. 
    197189     * 
    198      *  @see BuildListener::taskFinished() 
    199      *  @see BuildListener::targetFinished() 
    200      *  @see BuildListener::buildFinished() 
     190     * @see BuildListener::taskFinished() 
     191     * @see BuildListener::targetFinished() 
     192     * @see BuildListener::buildFinished() 
     193     * @return Exception 
    201194     */ 
    202     function getException() { 
     195    public function getException() { 
    203196        return $this->exception; 
    204197    }