Source for file OCSP_DIRECTORY.phpclass

Documentation is available at OCSP_DIRECTORY.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file OCSP_DIRECTORY
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package common
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-09.06.2008
  12.   * @version $Id: OCSP_DIRECTORY.phpclass,v 1.4 2008/11/06 08:41:58 pitlinz Exp $
  13.   */
  14.  
  15. // ---------------------------------------------------------
  16. // requirements
  17. // ---------------------------------------------------------
  18.  
  19.     if (!function_exists('pcf_require_class'))
  20.     {
  21.         require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . "pcf.phpinc";
  22.     }
  23.     
  24.     if (!function_exists('pcf_checkDir'))
  25.     {
  26.         require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . "pcf_directory.phpinc";
  27.     }
  28.  
  29. /**
  30.   * openCSP class OCSP_DIRECTORY
  31.   *
  32.   * @project Open CSP-Management
  33.   * @package default
  34.   *
  35.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  36.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  37.   *
  38.   * @since pk-09.06.2008
  39.   * @version $Id: OCSP_DIRECTORY.phpclass,v 1.4 2008/11/06 08:41:58 pitlinz Exp $
  40.   */
  41. class OCSP_DIRECTORY
  42. {
  43.     /*** class constants  --------------------------------------------- */
  44.  
  45.     /**
  46.      * @constant string CLASS_SRC_FILE
  47.      *
  48.      * @abstract
  49.      */
  50.     const CLASS_SRC_FILE = __FILE__;
  51.     
  52.     /*** class variables  --------------------------------------------- */
  53.     
  54.     /*** class methods ------------------------------------------------ */
  55.     
  56.     /**
  57.      * returns if $aDir is a directory
  58.      *
  59.      * @param string $aDir 
  60.      * @param boolean $allowLink 
  61.      * 
  62.      * @return boolean 
  63.      */
  64.     public static function isDir($aDir,$allowLink=True)
  65.     {
  66.         if (is_dir($aDir))
  67.         {
  68.             return True;
  69.         } else if ($allowLink && is_link($aDir) && ($aDir=readlink($aDir))) {
  70.             return self::isDir($aDir,$allowLink);
  71.         } else {
  72.             return False;
  73.         }        
  74.     }
  75.     
  76.     /**
  77.      * checks if a dir exits and creats it if $createDir
  78.      *
  79.      * @param string $aDir 
  80.      * @param boolean $createDir 
  81.      * @param octal $rMask 
  82.      * @param boolean $debug 
  83.      * 
  84.      * @return boolean 
  85.      */
  86.     public static function checkDir($aDir,$createDir=False,$rMask=0770,$debug=False)
  87.     {
  88.         return pcf_checkDir($aDir,$createDir,$rMask,$debug);
  89.     }
  90.     
  91.     /**
  92.      * checks if $aDir is a valid dirname fixes chars and /
  93.      * 
  94.      * if $isPath is not set $aDir is searched for $pathSep
  95.      *
  96.      * @param string $aDir 
  97.      * @param char $pathSep 
  98.      * @param int $isPath 
  99.      * @param boolean $debug 
  100.      * 
  101.      * @return string 
  102.      * 
  103.      */
  104.     public static function checkDirName($aDir,$pathSep=_OCSP_DIRSEP_,$isPath=-1,$debug=False)    
  105.     {
  106.         if ($debug) echoDebugMethod(__FILE__,"static","OCSP_DIRECTORY::checkDirName");
  107.         
  108.         $str_dir = trim($aDir);
  109.         if ($isPath == -1)
  110.         {
  111.             $bol_isPath = (strstr($str_dir,$pathSep) ? True :  False);
  112.         } else {
  113.             $bol_isPath = (intval($isPath) ? True : False);
  114.         }
  115.  
  116.         if ($bol_isPath)
  117.         {
  118.             $str_ret = ((substr($str_dir,0,1)==$pathSep) ? $pathSep : "");
  119.             if ($arr_path = explode($pathSep,$str_dir))
  120.             {
  121.                 foreach($arr_path as $str_dirName)
  122.                 {
  123.                     if (!empty($str_dirName))
  124.                     {
  125.                         $str_ret .= self::checkDirName($str_dirName,$pathSep,0,$debug) . $pathSep; 
  126.                     }
  127.                 }
  128.                 return $str_ret;
  129.             }
  130.             return False;
  131.         } else {
  132.             
  133.             $str_dir = str_replace("Ä","Ae",$str_dir);
  134.             $str_dir = str_replace("ä","ae",$str_dir);
  135.             $str_dir = str_replace("Ö","Oe",$str_dir);
  136.             $str_dir = str_replace("ö","oe",$str_dir);
  137.             $str_dir = str_replace("Ü","Ue",$str_dir);
  138.             $str_dir = str_replace("ü","ue",$str_dir);
  139.             $str_dir = str_replace("ß","ss",$str_dir);
  140.             $str_dir = str_replace("€","EURO",$str_dir);
  141.         
  142.             return preg_replace('/[^a-z0-9_\-\.]/i', '_', $str_dir);            
  143.         }
  144.         
  145.         
  146.     }
  147.     
  148.     /**
  149.       * returns an array with files of a specified type in a directory
  150.         *
  151.       * possible types:
  152.       * - F   = FILE
  153.       * - D   = DIRECTORY
  154.       * . !D  = WITHOUT DIRECTORIES (pk-04-08-18)
  155.       * - L   = LINK
  156.       * - A   = ALL
  157.       *
  158.       * Combination of types are also allowed
  159.       * FL returns files and links
  160.       *
  161.       * @param string $dirName (the directory)
  162.       * @param string $type (file type(s))
  163.       * @param boolean $debug 
  164.       * @param array $blackList 
  165.       *
  166.       * @return array 
  167.       */
  168.     public static function getDirList($dirName,$type="F",$debug=FALSE,$blackList=array())
  169.     {
  170.         return pcf_getDirList($dirName,$type,$debug,$blackList);        
  171.     }
  172.     
  173.     
  174.     
  175.     /*** compostion --------------------------------------------------- */
  176.     
  177.     /*** attributes  -------------------------------------------------- */
  178.     
  179.     /*** factory / construct  ----------------------------------------- */
  180.     
  181.     /*** getter / setter ---------------------------------------------- */
  182.     
  183.     
  184. }
  185.  
  186. ?>

Documentation generated on Thu, 08 Jan 2009 17:45:36 +0100 by phpDocumentor 1.4.0a2