[Sommaire] [Imprimer]

   1  <?php
   2  
   3  /*
   4   *  $Id: Description.php 3076 2006-12-18 08:52:12Z fabien $
   5   *
   6   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   7   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   8   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   9   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  10   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  11   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  12   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  13   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  14   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  15   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  16   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  17   *
  18   * This software consists of voluntary contributions made by many individuals
  19   * and is licensed under the LGPL. For more information please see
  20   * <http://phing.info>.
  21   */
  22  
  23  /**
  24   * Description is used to provide a project-wide description element
  25   * (that is, a description that applies to a buildfile as a whole).
  26   * If present, the &lt;description&gt; element is printed out before the
  27   * target descriptions.
  28   * 
  29   * Description has no attributes, only text.  There can only be one
  30   * project description per project.  A second description element will
  31   * overwrite the first.
  32   *
  33   * @author Hans Lellelid <hans@xmpl.org> (Phing)
  34   * @author Craeg Strong <cstrong@arielpartners.com> (Ant)
  35   * @package phing.types
  36   */
  37  class Description extends DataType {
  38  
  39      /**
  40       * Adds descriptive text to the project.
  41       *
  42       * @return void
  43       */
  44      public function addText($text) {
  45          $currentDescription = $this->project->getDescription();
  46          if ($currentDescription === null) {
  47              $this->project->setDescription($text);
  48          } else {
  49              $this->project->setDescription($currentDescription . $text);
  50          }
  51      }
  52      
  53  }