sTEFANs Subversion Web Contol (SWC)
Config
[ class tree: Swc ] [ index: Swc ] [ all elements ]

Source for file std_config2.inc.php

Documentation is available at std_config2.inc.php

  1. <?php
  2. /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. SVN Web Control
  4. Copyright ©2006 by sTEFANs
  5. Created on 26.02.2006
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 59 Temple Place - Suite 330,
  20. Boston, MA 02111-1307, USA.
  21. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22. */
  23.  
  24. /**
  25.  * This file contains sample implementation for a project configuration
  26.  * for Test Project 1.
  27.  * <b>Please have a close look to this file for details on <i>SwcConfig</i></b>.
  28.  * 
  29.  * @package Swc
  30.  * @subpackage Config
  31.  * @author Stefan Schraml
  32.  * @copyright Copyright ©2006 by sTEFANs
  33.  * @license http://opensource.org/licenses/lgpl-license.php GNU General Public License
  34.  * @version v1.1.0
  35.  * @since v1.0.0
  36.  */
  37.  
  38. /** Interfaces for configuration. */
  39. require_once ('inc/config.inc.php');
  40.  
  41. /** 
  42.  * This class implements a sample configuration
  43.  * for Test Project 1.
  44.  * @see config.inc.php
  45.  * @see SwcConfig
  46.  * 
  47.  * @package Swc
  48.  * @subpackage Config
  49.  * @version v1.1.0
  50.  * @since v1.0.0
  51.  */
  52. class TestProject2Config implements SwcConfig {
  53.  
  54.     /** 
  55.      * Returns a user friendly name for the project.
  56.      * @return string User friendly project name.
  57.      * 
  58.      * @since v1.0.0
  59.      */
  60.     public function GetProjectName(){
  61.         return "SVN Web Control Test 2";
  62.     }
  63.     
  64.     /** 
  65.      * Returns the relative URL of the Webpage under control.
  66.      * @return string URL of page to display in MainFrame.
  67.      * 
  68.      * @since v1.0.0
  69.      */
  70.     public function GetMainFrame(){
  71.         return "../test_project2/test.html";
  72.     }
  73.     
  74.     /** Returns the URL of the repository for the main frame.
  75.      * @return string URL of repository. Any protocol
  76.      *  (http://, svn://, etc.) is supported.
  77.      *  <br>
  78.      *  <b>Note:</b> <i>public function GetRepositoryRootDir</i> is deprecated
  79.      *  and removed from <i>SwcConfig</i> interface in SWC v1.1.0.
  80.      *  Please use <i>GetRepositoryRoot</i> instead. */
  81.     public function GetRepositoryRoot(){
  82.         return 'http://your-svn-server/svn_web_control';
  83.     }
  84.     
  85.     /** 
  86.      * Returns the absolute path of the repository in the local file system.
  87.      * @return string Absolute path of the repository.
  88.      * @deprecated v1.1.0 Use GetRepositroyRoot() instead to configure the repository root.
  89.      * @see SwcConfig::GetRepositoryRoot
  90.      * @since v1.0.0
  91.      */
  92.     public function GetRepositoryRootDir(){
  93.         return '/path-to-repository/svn_web_control';
  94.     }
  95.     
  96.     /*
  97.      * Configured in SwcConfigAdapter but can be overwritten here.
  98.      *  
  99.      * Returns subdirectories which contains directories for tags. 
  100.      * @return array or string (Array of) repository directory that contains tags.
  101.      *  
  102.      * @since v1.0.0
  103.     public function GetTagDirs(){
  104.         return 'tags/';
  105.     }
  106.      */
  107.     
  108.     /*
  109.      * Configured in SwcConfigAdapter but can be overwritten here.
  110.      *
  111.      * Returns the maximum depth of directories that should be considered
  112.      * as tag directory underneath <b>GetTagDirs()</b> hierarchy.
  113.      * E.g. if this is set to 2 than GetTagDirs()/dir1/dir2 is considered
  114.      * as tag directory while GetTagDirs()/dir1/dir2/dir3 is not.
  115.      * @return int Maximal path depth for tag directories.
  116.      *  
  117.      * @since v1.0.0
  118.     public function GetMaxTagDirDepth(){
  119.         return 1;
  120.     }
  121.      */
  122.     
  123.     /*
  124.      * Configured in SwcConfigAdapter but can be overwritten here.
  125.      * 
  126.      * Returns subdirectories which contains directories for branches. 
  127.      * @return array or string (Array of) repository directory that contains branches.
  128.      *  
  129.      * @since v1.0.0
  130.     public function GetBranchDirs(){
  131.         return 'branches/';
  132.     }
  133.      */
  134.     
  135.     /*
  136.      * Configured in SwcConfigAdapter but can be overwritten here.
  137.      * 
  138.      * Returns the maximum depth of directories that should be considered
  139.      * as branch directory underneath <b>GetBranchDirs()</b> hierarchy.
  140.      * E.g. if this is set to 2 than GetBranchDirs()/dir1/dir2 is considered
  141.      * as tag directory while GetBranchDirs()/dir1/dir2/dir3 is not.
  142.      * @return int Maximal path depth for branch directories.
  143.      *  
  144.      * @since v1.0.0
  145.     public function GetMaxBranchDirDepth(){
  146.         return 0;
  147.     }
  148.      */
  149.     
  150.     /*
  151.      * Configured in SwcConfigAdapter but can be overwritten here.
  152.      * 
  153.      * Returns subdirectoy which contains repository trunk. 
  154.      * @return string Repository directory that contains main developement.
  155.      *  
  156.      * @since v1.0.0
  157.     public function GetTrunkDir(){
  158.         return 'trunk/';
  159.     }
  160.      */
  161.      
  162.     /** 
  163.      * Returns the HTTP URL for the workspace where the project
  164.      * is checked out. Used by SVN.
  165.      * @return string URL of Webspace.
  166.      * @deprecated v1.1.0 Use <i>GetWebspaceRootDir</i> instead to configure
  167.      *  webspace.
  168.      * @see SwcConfig::GetWebspaceRootDir
  169.      * @since v1.0.0
  170.      */
  171.     public function GetWebspaceRoot(){
  172.         return 'http://your-webspace/';
  173.     }
  174.     
  175.     /** Returns the absolute path of the workspace directory in the local file system.
  176.      * @return string Absolute path of the workspace.
  177.      *  <br>
  178.      *  <b>Note:</b> <i>public function GetWebspaceRoot</i> is deprecated
  179.      *  and removed from <i>SwcConfig</i> interface in SWC v1.1.0.
  180.      *  Please use <i>GetWebspaceRootDir</i> instead.
  181.      * @since v1.0.0
  182.      */
  183.     public function GetWebspaceRootDir(){
  184.         return '/path-to-your-webspace/';
  185.     }
  186.     
  187.     /*
  188.      * Configured in SwcConfigAdapter but can be overwritten here.
  189.      *  
  190.      * Returns the SVN user which should be used for repository access. 
  191.      * @return string SVN user.
  192.      *  
  193.      * @since v1.0.0
  194.     public function GetSvnUser(){
  195.         return 'swc_user';
  196.     }
  197.      */
  198.     
  199.     /*
  200.      * Configured in SwcConfigAdapter but can be overwritten here.
  201.      *  
  202.      * Returns the password of the SVN user which should be used for repository access. 
  203.      * @return string Password of SVN user.
  204.      *  
  205.      * @since v1.0.0
  206.     public function GetSvnPassword(){
  207.         return 'swc_password';
  208.     }
  209.      */
  210.     
  211.     /** 
  212.      * Returns the URL of WebSVN view for this project or NULL if WebSVN is not available.
  213.      * 
  214.      * @since v1.0.0
  215.      */
  216.     public function GetWebSvnUrl(){
  217.         return 'http://websvn-location?project-params';
  218.     }
  219.     
  220.     /*
  221.      * Configured in SwcConfigAdapter but can be overwritten here.
  222.      *  
  223.      * Returns true if SVN command bar may be shown, false otherwise. 
  224.      * This setting overrides corresponding user setting in order to
  225.      * protect the system agaist malicious commands. 
  226.      * 
  227.      * @since v1.0.0
  228.     public function IsSvnCommandBarEnabled(){
  229.         return true;
  230.     }
  231.      */
  232. }
  233. ?>

Documentation generated on Fri, 03 Nov 2006 18:45:00 +0100 by phpDocumentor 1.3.0RC6
for sTEFANs POWERED BY eBC.bz