home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / PHPDoc / core / PhpdocSetupHandler.php < prev   
Encoding:
PHP Script  |  2001-02-18  |  6.7 KB  |  217 lines
  1. <?php
  2. /**
  3. * Handles the "setup".
  4. *
  5. * This class provides all methods neccessary to "setup" Phpdoc and check the 
  6. * current setup.
  7. * 
  8. * @version  $Id: PhpdocSetupHandler.php,v 1.6 2001/02/18 15:29:29 uw Exp $
  9. * @author   Ulf Wendel <ulf@redsys.de>
  10. */
  11. class PhpdocSetupHandler extends PhpdocArgvHandler {
  12.  
  13.     /**
  14.     * Name of the target directory.
  15.     *
  16.     * @var      string  $target
  17.     * @access   private
  18.     */                                
  19.     var $target = "";    
  20.     
  21.     /**
  22.     * Name of the application parsed
  23.     *
  24.     * @var  string  $application
  25.     * @see  setApplication()
  26.     */
  27.     var $application = "PHPDoc";
  28.     
  29.     /**
  30.     * Basedir for all file operations
  31.     *
  32.     * @var  string
  33.     * @see  setApplication()
  34.     */
  35.     var $basedir = "";
  36.     
  37.     /**
  38.     * Suffix for all rendered files in the application (except for the xml files).
  39.     *
  40.     * @var  string  targetFileSuffix
  41.     * @see  setTargetFileSuffix()
  42.     */
  43.     var    $targetFileSuffix = ".html";
  44.     
  45.     /**
  46.     * Suffix of all source code files in the application
  47.     *
  48.     * If you used other file suffixes than ".php" in you have to override this.
  49.     *
  50.     * @var  array    sourceFileSuffix
  51.     * @see  setSourceFileSuffix()
  52.     */
  53.     var    $sourceFileSuffix = array ( "php" );
  54.     
  55.     /**
  56.     * Directory with the php sources to parse.
  57.     *
  58.     * @var   string    
  59.     * @see   setSourceDirectory()
  60.     */
  61.     var $sourceDirectory = "";    
  62.     
  63.     /**
  64.     * Sets the name of the directory with the source to scan.
  65.     *
  66.     * @param    string
  67.     * @access   public
  68.     */
  69.     function setSourceDirectory($sourcedir) {
  70.         $this->sourceDirectory = $this->getCheckedDirname($sourcedir);
  71.     } // end end func setSourceDirectory
  72.     
  73.     /**
  74.     * Sets the name of the directory with the templates.
  75.     *
  76.     * @param    string
  77.     * @access   public
  78.     */
  79.     function setTemplateDirectory($sourcedir) {
  80.         $this->templateRoot = $this->getCheckedDirname($sourcedir);
  81.     } // end func setTemplateDirectory
  82.     
  83.     /**
  84.     * Sets the name of your application. 
  85.     * 
  86.     * The application name gets used on many places in the default templates.
  87.     * 
  88.     * @param    string      $application    name of the application
  89.     * @return   bool        $ok
  90.     * @throws   PhpdocError    
  91.     * @access   public
  92.     */    
  93.     function setApplication($application) {
  94.         if ("" == $application) {
  95.             $this->err[] = new PhpdocError("No application name given.", __FILE__, __LINE__);
  96.             return false;
  97.         }
  98.         
  99.         $this->application = $application;
  100.         return true;
  101.     } // end func setApplication
  102.     
  103.     /**
  104.     * Suffix for all rendered files in the application (not for the xml files)
  105.     *
  106.     * By default the the suffix is set to ".html".
  107.     *
  108.     * @param    string  $suffix string with the suffix
  109.     * @return   boolean $ok
  110.     * @see      $targetFileSuffix
  111.     * @author   Thomas Weinert <subjective@subjective.de>
  112.     */
  113.     function setTargetFileSuffix($suffix) {
  114.         if ("" != $suffix && "." != $suffix[0]) {
  115.             $this->err[] = new PhpdocError("Make sure that the file extension starts with a dot.", __FILE__, __LINE__);
  116.             return false; 
  117.         }
  118.         
  119.         $this->targetFileSuffix = $suffix;
  120.         return true;
  121.     }
  122.  
  123.     /**
  124.     * Suffix of all source code files in the application
  125.     *
  126.     * By default only files with the suffix ".php" are recognized as
  127.     * php source code files and parsed. If you used other
  128.     * suffixes such as ".inc" you have to tell phpdoc to parse
  129.     * them.
  130.     *
  131.     * @param    mixed   $suffix        string with one suffix or array of suffixes
  132.     * @return   boolean $ok
  133.     * @throws   PhpdocError
  134.     * @see      $sourceFileSuffix
  135.     */
  136.     function setSourceFileSuffix($suffix) {
  137.         if ( (!is_array($suffix) && "" == $suffix) || (is_array($suffix) && 0 == count($suffix)) ) {
  138.             $this->err[] = new PhpdocError("No suffix specified.", __FILE__, __LINE__);
  139.             return false;
  140.         }
  141.         if (!is_array($suffix)) 
  142.             $suffix = array($suffix);        
  143.         
  144.         $this->sourceFileSuffix = $suffix;    
  145.         return true;
  146.     } // end func setSourceFileSuffix
  147.  
  148.     /**
  149.     * Sets the target where the generated files are saved.
  150.     * 
  151.     * @param    string  $target
  152.     * @return   boolean $ok 
  153.     * @throws   PhpdocError
  154.     * @access   public
  155.     */
  156.     function setTarget($target) {
  157.         if ("" == $target) {
  158.             $this->err[] = new PhpdocError("No target specified.", __FILE__, __LINE__);
  159.             return false;
  160.         }
  161.         
  162.         if (!is_dir($target)) {
  163.             $ok = mkdir($target, 0755);
  164.             if (!$ok) {
  165.                 $this->err[] = new PhpdocError("setTarget(), can't create a directory '$target'.", __FILE__, __LINE__);
  166.                 return false;
  167.             }
  168.         }
  169.             
  170.         $this->target = $this->getCheckedDirname($target);
  171.         return true;
  172.     } // end func setTarget
  173.  
  174.     /**
  175.     * Checks the current status of the object. Are all necessary informations to start parsing available?
  176.     *
  177.     * @param    mixed   $errors
  178.     * @return   array   $errors
  179.     */
  180.     function checkStatus($errors = "") {
  181.         if (!is_array($errors))
  182.             $errors = array();
  183. /*
  184.                 
  185.         if (0==count($this->files) && ""==$this->directory) 
  186.             $errors[] = array (
  187.                                                     "msg"     => "No source files or source directory specified.",
  188.                                                     "type"    => "misconfiguration",
  189.                                                     "errno"    => 6
  190.                                                 );
  191.                                                 
  192.         if (0!=count($this->files) && ""!=$this->directory) 
  193.             $errors[] = array(
  194.                                                     "msg"        => "Define eighter some files or a diretory.",
  195.                                                     "type"    => "misconfiguration",
  196.                                                     "errno"    => 7
  197.                                             );
  198.     */    
  199.         return $errors;
  200.     } // end func checkStatus
  201.     
  202.     /**
  203.     * Adds a slash at the end of the given filename if neccessary.
  204.     *
  205.     * @param    string    Directoryname
  206.     * @return    string    Directoryname
  207.     */
  208.     function getCheckedDirname($dirname) {
  209.  
  210.         if ("" != $dirname && "/" != substr($dirname, -1)) 
  211.             $dirname .= "/";
  212.             
  213.         return $dirname;
  214.     } // end func getCheckedDirname
  215.  
  216. } // end class PhpdocSetupHandler
  217. ?>