Xinc-Plugin-Task
[ class tree: Xinc-Plugin-Task ] [ index: Xinc-Plugin-Task ] [ 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:
Base.php
Exception.php
Interface.php
Interface.php
Interface.php
Interface.php

Interfaces:
Xinc_Plugin_Task_Interface
Xinc_Plugin_Task_Parent_Interface
Xinc_Plugin_Task_Processor_Interface
Xinc_Plugin_Task_Setter_Interface
Classes:
Xinc_Plugin_Task_Base
Xinc_Plugin_Task_Exception

Class: Xinc_Plugin_Task_Interface

Source Location: /Xinc/Plugin/Task/Interface.php

Interface Overview













        






Methods
























Class Details



[line 33]






[ Top ]








Class Methods




  

	
	
constructor __construct [line 38]

	

    

    

		Xinc_Plugin_Task_Interface __construct(
Xinc_Plugin_Interface
$plugin)
    

    


	
		Constructor





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Plugin_Interface  
        $plugin  
        
      

        

    


        
[ Top ]

  

  

	
	
method getName [line 63]

	

    

    

		string getName(
)
    

    


	
		Returns name of task.





Tags:





  

    return:  Name of task.
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPluginSlot [line 71]

	

    

    

		integer getPluginSlot(
)
    

    


	
		Returns the slot of this task inside a build.





Tags:





  

    return:  The slot number.
  

  

    see:  Xinc/Plugin/Slot.php for available slots
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getTasks [line 72]

	

    

    

		void getTasks(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getXml [line 73]

	

    

    

		void getXml(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method init [line 39]

	

    

    

		void init(
Xinc_Build_Interface
$build)
    

    


	
		



Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Build_Interface  
        $build  
        
      

        

    


        
[ Top ]

  

  

	
	
method process [line 40]

	

    

    

		void process(
Xinc_Build_Interface
$build)
    

    


	
		



Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Build_Interface  
        $build  
        
      

        

    


        
[ Top ]

  

  

	
	
method registerTask [line 49]

	

    

    

		void registerTask(
Xinc_Plugin_Task_Interface
$task)
    

    


	
		Support for subtasks, empty by default.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        Xinc_Plugin_Task_Interface  
        $task  
        Task to register
      

        

    


        
[ Top ]

  

  

	
	
method setXml [line 74]

	

    

    

		void setXml(
SimpleXMLElement
$element)
    

    


	
		



Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        SimpleXMLElement  
        $element  
        
      

        

    


        
[ Top ]

  

  

	
	
method validate [line 56]

	

    

    

		boolean validate(
)
    

    


	
		Validates if a task can run by checking configs, directries and so on.





Tags:





  

    return:  Is true if task can run.
  

  

    access:  public
  









	
        
[ Top ]

  






        

		    

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