210. ProductControl

Product Control routines

210.1. Authors

  • Anas Nashif <nashif@suse.de>

  • Stanislav Visnovsky <visnov@suse.cz>

  • Jiri Srain <jsrain@suse.cz>

  • Lukas Ocilka <locilka@suse.cz>

210.2. Summary of Module Globals

List of Global Functions

List of Global Variables

    210.3. Global Functions

    210.3.1. AddWizardSteps

    Add Wizard Steps

    Function parameters

    • list<map> stagemode

    Return value

    • void

    210.3.2. DisableModule

    Disable given module in installation workflow

    Function parameters

    • string modname

    Return value

    • list<string> - current list of disabled modules

    210.3.3. DisableProposal

    Disable given proposal in installation workflow

    Function parameters

    • string disable_proposal

    Return value

    • list<string> - current list of disabled proposals

    210.3.4. EnableModule

    Enable given disabled module

    Function parameters

    • string modname

    Return value

    • list<string> - current list of disabled modules

    210.3.5. EnableProposal

    Enable given disabled proposal

    Function parameters

    • string enable_proposal

    Return value

    • list<string> - current list of disabled proposals

    210.3.6. GetDisabledModules

    Returns list of modules disabled in workflow

    Return value

    • list <string> - DisabledModules

    210.3.7. GetDisabledProposals

    Returns list of proposals disabled in workflow

    Return value

    • list <string> - DisabledProposals

    210.3.8. GetUseAutomaticConfiguration

    Returns whether automatic configuration will be enabled.

    Return value

    • boolean - if enabled

    210.3.9. Init

    Initialize Product Control

    Return value

    • boolean - True on success

    210.3.10. InitAutomaticConfiguration

    Inits the default value for use_automatic_configuration

    Return value

    • void

    210.3.11. ProductControl

    ProductControl Constructor

    Return value

    • void

    210.3.12. ReadControlFile

    Read XML Control File

    Function parameters

    • string controlfile

    Return value

    • boolean

    210.3.13. RequiredFiles

    Get list of required files for the workflow.

    Function parameters

    • string stage

    • string mode

    Return value

    • list<string> - Required files list.

    210.3.14. ResetAdditionalWorkflowParams

    Resets all additional params for selecting the workflow

    Return value

    • void

    See also:

    • SetAdditionalWorkflowParams()

    210.3.15. RestartingStep

    Return step which restarted YaST (or rebooted the system)

    Return value

    • map - a map describing the step

    210.3.16. RetranslateWizardSteps

    Retranslate Wizard Steps

    Return value

    • void

    210.3.17. Run

    Run Workflow

    Return value

    • symbol

    210.3.18. RunRequired

    Returns whether is is required to run YaST in the defined stage and mode

    Function parameters

    • string stage

    • string mode

    Return value

    • boolean - if needed

    210.3.19. SetAdditionalWorkflowParams

    Sets additional params for selecting the workflow

    Function parameters

    • map <string, any> params

    Return value

    • void

    Example 82. 

     SetAdditionalWorkflowParams ($["add_on_mode":"update"]);
     SetAdditionalWorkflowParams ($["add_on_mode":"installation"]);


    210.3.20. SetUseAutomaticConfiguration

    Adjust the automatic configuration to be either enabled or disabled. Enabling it means that second stage will be disabled.

    Function parameters

    • boolean set_param

    Return value

    • void

    210.3.21. SkippedSteps

    List steps which were skipped since last restart of YaST

    Return value

    • list<map> - a list of maps describing the steps

    210.3.22. UpdateWizardSteps

    Update Steps

    Function parameters

    • list<map> stagemode

    Return value

    • void

    210.3.23. checkArch

    Check if valid architecture

    Function parameters

    • map mod

    • map def

    Return value

    • boolean - true if arch match

    210.3.24. checkDisabled

    Check if a module is disabled

    Function parameters

    • map mod

    Return value

    • boolean

    210.3.25. getClientTerm

    Return term to be used to run module with CallFunction

    Function parameters

    • map step

    • map def

    • any former_result

    Return value

    • term - module data with params

    210.3.26. getCompleteWorkflow

    Get Workflow

    Function parameters

    • string stage

    • string mode

    Return value

    • map - Workflow map

    210.3.27. getLockedProposals

    Get Proposal list that can not be changed by the user.

    Function parameters

    • string stage

    • string mode

    • string proptype

    Return value

    • list<string> - list of locked proposals

    210.3.28. getModeDefaults

    Get workflow defaults

    Function parameters

    • string stage

    • string mode

    Return value

    • map - defaults

    210.3.29. getModules

    Get modules of current Workflow

    Function parameters

    • string stage

    • string mode

    • symbol which

    Return value

    • list <map> - modules

    210.3.30. getProposalProperties

    Return proposal Label

    Function parameters

    • string stage

    • string mode

    • string proptype

    Return value

    • map

    210.3.31. getProposalTextDomain

    Return text domain

    Return value

    • string

    210.3.32. getProposals

    Get modules of current Workflow

    Function parameters

    • string stage

    • string mode

    • string proptype

    Return value

    • list < list > - modules

    210.3.33. getWorkflowLabel

    Get Workflow Label

    Function parameters

    • string stage

    • string mode

    • string wz_td

    Return value

    • string

    210.3.34. setClientPrefix

    Set Client Prefix

    Function parameters

    • string prefix

    Return value

    • void

    210.4. Global Variables

    210.5. Module Requirements

    210.5.1. Module Imports

    • Arch
    • Directory
    • FileUtils
    • Hooks
    • Installation
    • Label
    • Mode
    • Popup
    • ProductFeatures
    • Report
    • Stage
    • Wizard
    • XML

    210.5.2. Module Includes