Xinc-Engine
[ class tree: Xinc-Engine ] [ index: Xinc-Engine ] [ all elements ]
Packages:
default
Xinc
Xinc-Api
Xinc-Build
Xinc-Build-Exception
Xinc-Build-History-Exception
Xinc-Build-Labeler
Xinc-Build-Queue
Xinc-Build-Repository
Xinc-Build-Scheduler
Xinc-Build-Statistic-Exception
Xinc-Build-Status-Exception
Xinc-Build-Task
Xinc-Config
Xinc-Config-Exception
Xinc-Contrib
Xinc-Data
Xinc-Engine
Xinc-Engine-Exception
Xinc-Engine-Sunrise
Xinc-Gui
Xinc-Gui-Widget
Xinc-Gui-Widget-Exception
Xinc-Gui-Widget-Extension
Xinc-Ini
Xinc-Iterator
Xinc-Logger
Xinc-Logger-Exception
Xinc-Plugin
Xinc-Plugin-Exception
Xinc-Plugin-Publisher
Xinc-Plugin-Repos
Xinc-Plugin-Repos-Api
Xinc-Plugin-Repos-Api-Format
Xinc-Plugin-Repos-Builder
Xinc-Plugin-Repos-Builder-Phing
Xinc-Plugin-Repos-Configuration
Xinc-Plugin-Repos-Configuration-Setting
Xinc-Plugin-Repos-Cron
Xinc-Plugin-Repos-Gui
Xinc-Plugin-Repos-Gui-Artifacts
Xinc-Plugin-Repos-Gui-Artifacts-Extension
Xinc-Plugin-Repos-Gui-Dashboard
Xinc-Plugin-Repos-Gui-Dashboard-Detail
Xinc-Plugin-Repos-Gui-Dashboard-Detail-Extension
Xinc-Plugin-Repos-Gui-Dashboard-Extension
Xinc-Plugin-Repos-Gui-Dashboard-Projects
Xinc-Plugin-Repos-Gui-Dashboard-Projects-Extension
Xinc-Plugin-Repos-Gui-Deliverable
Xinc-Plugin-Repos-Gui-Deliverable-Extension
Xinc-Plugin-Repos-Gui-Documentation
Xinc-Plugin-Repos-Gui-Documentation-Extension
Xinc-Plugin-Repos-Gui-Index
Xinc-Plugin-Repos-Gui-Index-Extension
Xinc-Plugin-Repos-Gui-Menu
Xinc-Plugin-Repos-Gui-Menu-Extension
Xinc-Plugin-Repos-Gui-ModificationSet
Xinc-Plugin-Repos-Gui-ModificationSet-Extension
Xinc-Plugin-Repos-Gui-PhpUnitTestResults
Xinc-Plugin-Repos-Gui-PhpUnitTestResults-Extension
Xinc-Plugin-Repos-Gui-Statistics
Xinc-Plugin-Repos-Gui-Statistics-Extension
Xinc-Plugin-Repos-Gui-Statistics-Graph
Xinc-Plugin-Repos-Gui-Statistics-Menu
Xinc-Plugin-Repos-ModificationSet
Xinc-Plugin-Repos-ModificationSet-BuildAlways
Xinc-Plugin-Repos-ModificationSet-Git
Xinc-Plugin-Repos-ModificationSet-Svn
Xinc-Plugin-Repos-Phing
Xinc-Plugin-Repos-Property
Xinc-Plugin-Schedule
Xinc-Plugin-Task
Xinc-Postinstall
Xinc-Project
Xinc-Registry


Files:
Interface.php
Iterator.php
Parser.php
Repository.php
Sunrise.php

Interfaces:
Xinc_Engine_Interface
Classes:
Xinc_Engine_Iterator
Xinc_Engine_Parser
Xinc_Engine_Repository
Xinc_Engine_Sunrise

Class: Xinc_Engine_Interface

Source Location: /Xinc/Engine/Interface.php

Interface Overview




Xinc - Continuous Integration.




Author(s):






          
          


Copyright:


    
  
  • 2007 Arno Schneider, Barcelona
    • 


        






Methods
























Class Details



[line 31]

Xinc - Continuous Integration.

Engine to build projects
PHP version 5





Tags:





  

    author:  Arno Schneider <username@example.org>
  

  

    copyright:  2007 Arno Schneider, Barcelona
  

  

    link:  http://xincplus.sourceforge.net
  

  

    license:  GNU/LGPL, see license.php
            This file is part of Xinc.
            Xinc is free software; you can redistribute it and/or modify
            it under the terms of the GNU Lesser General Public License as
            published by the Free Software Foundation; either version 2.1 of
            the License, or (at your option) any later version.

            Xinc is distributed in the hope that it will be useful,
            but WITHOUT ANY WARRANTY; without even the implied warranty of
            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
            GNU Lesser General Public License for more details.

            You should have received a copy of the GNU Lesser General Public
            License along with Xinc, write to the Free Software Foundation,
            Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  










[ Top ]








Class Methods




  

	
	
method build [line 46]

	

    

    

		void build(
Xinc_Build_Interface
&$build, Xinc_Build_Interface
$build)
    

    


	
		process the build





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Build_Interface  
        $build  
        
      

          

        Xinc_Build_Interface  
        &$build  
        
      

        

    


        
[ Top ]

  

  

	
	
method getHeartBeat [line 63]

	

    

    

		integer getHeartBeat(
)
    

    


	
		returns the interval in seconds in which  the engine checks for new builds





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 39]

	

    

    

		string getName(
)
    

    


	
		get the name of the engine





Tags:





  

    return:  Name of the engine.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method parseProjects [line 55]

	

    

    

		Xinc_Build_Iterator parseProjects(
Xinc_Project_Iterator
$projects)
    

    


	
		Parses Project-Xml and returns





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Project_Config_Iterator  
        $projects  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHeartBeat [line 73]

	

    

    

		void setHeartBeat(
unknown_type
$seconds)
    

    


	
		Set the interal in which the engine checks  for modified builds, necessary builds etc





Tags:





  

    see:  <xinc engine="name" heartbeat="10"/>
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        unknown_type  
        $seconds  
        
      

        

    


        
[ Top ]

  

  

	
	
method validate [line 80]

	

    

    

		boolean validate(
)
    

    


	
		Validate if the engine can run properly on this system





Tags:





  

    return:  True if engine can run properly otherwise false.
  

  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Sun, 09 Dec 2012 21:49:27 +0100 by phpDocumentor 1.4.4