tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Class: Tangra_Module_Info

Source Location: /modules_manager/tangra_module_info.class.php

Class Tangra_Module_Info

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

Tangra_Module_Info servers as a container for information parsed from module.ctrl file.

Information that this class encapsulates is waht module installer needs to perform an installation.

Located in /modules_manager/tangra_module_info.class.php [line 22] 

Tangra_Class
   |
   --Tangra_Module_Info

Properties

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Tangra_Class

Tangra_Class::get_class_name()
Alias of get_class(). Exist because of historical reasons.
Tangra_Class::__set()
Overides PHP built-in method and just throws exception if called. Purpose - to "forbid" autosetting of nonexisting class properties.

[ Top ]
Property Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $category_hids   Hilds category hid for categories that are added to this module
array   $conflicts   Array of modules with which module conflicts
array   $depends   Array of modules on which module depends
string   $description   Description
array   $enhances   Array of modules that module enhances
array   $hard_optional_params   List ot hard optional parameters
string   $installer_class   Name of the class inherited from Module_Installer
string   $maintainer   Name and email of the maintainer of the module
string   $module_name   Name of the module
string   $module_path   Path where install source files of module reside
array   $predepends   Array of modules on which module predepends (i.e. have to be installed and configured)
array   $provides   Array of modules which module provides (virtual modules)
array   $recommends   Array of modules with which module recommends to be also installed
array   $required_params   List ot required optional parameters
string   $requires_tangra_lib_version   Whan is minimal version of TL that this module can work with
array   $soft_optional_params   List ot soft optional parameters
array   $suggests   Array of modules with which module suggests to be also installed
string   $version   Version of the module

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
void   add_category_hid()   Adds category hid
void   add_conflicts()   Adds new conflicts:
void   add_depends()   Adds new depends:
void   add_enhances()   Adds new enhances:
void   add_hard_optional_param()   Adds hard optional parameter
void   add_predepends()   Adds new predepends:
void   add_provides()   Adds new provides:
void   add_recommends()   Adds new recommends:
void   add_required_param()   Adds hard optional parameter
void   add_soft_optional_param()   Adds soft optional parameter
void   add_suggests()   Adds new suggests:
void   category_hid_exists()  
array   get_category_hids()   Returns $category_hids
array   get_conflicts()   Returns list of modules that this module is conflicting with
array   get_depends()   Returns list of modules that this module depends on
unknown   get_description()   Returns description
array   get_enhances()   Returns list of module that this module is enhances
array   get_hard_optional_params()   Returns hard optional parameters list
unknown   get_installer_class()   Returns installer class name
unknown   get_maintainer()   Returns module's maintainer name (and email)
string   get_module_identificator()   Returns module identificator
string   get_module_name()   Returns module name
string   get_module_path()   Returns path where module is located in install form, i.e. install source files (not installed files)
unknown   get_predepends()   Returns list of modules that this module predepends on
array   get_provides()   Returns list of modules that this module provide
array   get_recommends()   Returns list of modules that this module is recommends
array   get_required_params()   Returns required parameters list
string   get_requires_tangra_lib_version()   Returns minimal required version of TL that this module needs
array   get_soft_optional_params()   Returns soft optional parameters list
array   get_suggests()   Returns list of module that this module is suggests
string   get_version()   Returns module version
boolean   hard_optional_param_exists()   Checks if hard optional param is already added
void   init_with_module_info_arr()   Initializes this object with data passed in array with specific structure
boolean   is_depending_on()   Checks if this module is depending on module $module_name_query
boolean   is_providing()   Checks if this module is providing module $module_name_query
boolean   required_param_exists()   Checks if required optional param is already added
void   set_category_hids()   Sets $category_hids
void   set_conflicts()   Sets list of modules that this module is conflicting with
void   set_depends()   Sets list of modules that this module depends on
void   set_description()   Sets description
void   set_enhances()   Sets list of module that this module is enhances
void   set_installer_class()   Sets installer class name
void   set_maintainer()   Sets module's maintainer name and email
void   set_module_name()   Sets module name
void   set_module_path()   Sets path where module is located in install form, i.e. install source files (not installed files)
void   set_predepends()   Sets list of modules that this module predepends on
void   set_provides()   Sets list of provide modules
void   set_recommends()   Sets list of modules that this module is recommends
void   set_requires_tangra_lib_version()   Sets minimal required version of TL that this module needs
void   set_suggests()   Sets list of modules that this module is suggests
void   set_version()   Sets module version
boolean   soft_optional_param_exists()   Checks if soft optional param is already added

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $category_hids = array() [line 150]

Hilds category hid for categories that are added to this module

API Tags:
Access:  private


[ Top ]
array   $conflicts = array() [line 85]

Array of modules with which module conflicts

API Tags:
Internal:  
Access:  private


[ Top ]
array   $depends = array() [line 71]

Array of modules on which module depends

API Tags:
Internal:  
Access:  private


[ Top ]
string   $description [line 43]

Description

API Tags:
Internal:  
Access:  private


[ Top ]
array   $enhances = array() [line 106]

Array of modules that module enhances

API Tags:
Internal:  
Access:  private


[ Top ]
array   $hard_optional_params = array() [line 128]

List ot hard optional parameters

API Tags:
Internal:  
Access:  private


[ Top ]
string   $installer_class [line 57]

Name of the class inherited from Module_Installer

API Tags:
Internal:  
Access:  private


[ Top ]
string   $maintainer [line 50]

Name and email of the maintainer of the module

API Tags:
Internal:  
Access:  private


[ Top ]
string   $module_name [line 29]

Name of the module

API Tags:
Internal:  
Access:  private


[ Top ]
string   $module_path [line 143]

Path where install source files of module reside

API Tags:
Internal:  
Access:  private


[ Top ]
array   $predepends = array() [line 113]

Array of modules on which module predepends (i.e. have to be installed and configured)

API Tags:
Internal:  
Access:  private


[ Top ]
array   $provides = array() [line 78]

Array of modules which module provides (virtual modules)

API Tags:
Internal:  
Access:  private


[ Top ]
array   $recommends = array() [line 92]

Array of modules with which module recommends to be also installed

API Tags:
Internal:  
Access:  private


[ Top ]
array   $required_params = array() [line 135]

List ot required optional parameters

API Tags:
Internal:  
Access:  private


[ Top ]
string   $requires_tangra_lib_version [line 64]

Whan is minimal version of TL that this module can work with

API Tags:
Internal:  
Access:  private


[ Top ]
array   $soft_optional_params = array() [line 121]

List ot soft optional parameters

API Tags:
Internal:  
Access:  private


[ Top ]
array   $suggests = array() [line 99]

Array of modules with which module suggests to be also installed

API Tags:
Internal:  
Access:  private


[ Top ]
string   $version [line 36]

Version of the module

API Tags:
Internal:  
Access:  private


[ Top ]
Methods
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
add_category_hid  [line 850]

  void add_category_hid( string $category_hid  )

Adds category hid

Parameters:
string   $category_hid: 

API Tags:
Access:  public


[ Top ]
add_conflicts  [line 495]

  void add_conflicts( string $module_name, string $version_requirement  )

Adds new conflicts:

Parameters:
string   $module_name: 
string   $version_requirement: 

API Tags:
Access:  public


[ Top ]
add_depends  [line 440]

  void add_depends( string $module_name, string $version_requirement  )

Adds new depends:

Parameters:
string   $module_name: 
string   $version_requirement: 

API Tags:
Access:  public


[ Top ]
add_enhances  [line 600]

  void add_enhances( string $module_name, string $version_requirement  )

Adds new enhances:

Parameters:
string   $module_name: 
string   $version_requirement: 

API Tags:
Access:  public


[ Top ]
add_hard_optional_param  [line 740]

  void add_hard_optional_param( string $param  )

Adds hard optional parameter

Parameters:
string   $param: 

API Tags:
Access:  public


[ Top ]
add_predepends  [line 635]

  void add_predepends( string $module_name, string $version_requirement  )

Adds new predepends:

Parameters:
string   $module_name: 
string   $version_requirement: 

API Tags:
Access:  public


[ Top ]
add_provides  [line 405]

  void add_provides( string $module_name, string $version_req  )

Adds new provides:

Parameters:
string