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

Class: Tangra_Module

Source Location: /modules_manager/tangra_module.class.php

Class Tangra_Module

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

Tangra Module Class

Located in /modules_manager/tangra_module.class.php [line 19] 

Tangra_Class
   |
   --Tangra_Module

Properties

Methods
[ Top ]
Descendants
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
Tangra_Module_DBC Tangra_Module_DBC

[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Descendants | 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 | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
string   $description   Short description about module
string   $hid   HID (human id) of the module. e.g. admin_panel
integer   $id   ID of the module
integer   $license   ID of the license under which module is released
string   $maintainer   Email address of maintainer of the module
string   $url   URL address of web page that contain more information about module

[ Top ]
Method Summary
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
unknown   get_description()   Gets module description
unknown   get_hid()   Gets module HID
integer   get_id()   Gets module id
integer   get_license()   Gets ID of the license under which module is released
string   get_maintainer()   Gets maintainer
string   get_url()   Gets URL address of web page that contain more information about module
void   set_description()   Sets module description
void   set_hid()   Sets module HID
void   set_id()   Sets module ID
void   set_license()   Sets ID of the license under which module is released
void   set_maintainer()   Sets module maintainer email
void   set_url()   Sets URL address of web page that contain more information about module

[ Top ]
Properties
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
string   $description [line 40]

Short description about module

API Tags:
Internal:  
Access:  private


[ Top ]
string   $hid [line 33]

HID (human id) of the module. e.g. admin_panel

API Tags:
Internal:  
Access:  private


[ Top ]
integer   $id [line 26]

ID of the module

API Tags:
Internal:  
Access:  private


[ Top ]
integer   $license [line 61]

ID of the license under which module is released

API Tags:
Internal:  
Access:  private


[ Top ]
string   $maintainer [line 47]

Email address of maintainer of the module

API Tags:
Internal:  
Access:  private


[ Top ]
string   $url [line 54]

URL address of web page that contain more information about module

API Tags:
Internal:  
Access:  private


[ Top ]
Methods
Class Overview | Descendants | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
get_description  [line 125]

  unknown get_description( )

Gets module description


API Tags:
Access:  public


[ Top ]
get_hid  [line 105]

  unknown get_hid( )

Gets module HID


API Tags:
Access:  public


[ Top ]
get_id  [line 81]

  integer get_id( )

Gets module id


API Tags:
Access:  public


[ Top ]
get_license  [line 188]

  integer get_license( )

Gets ID of the license under which module is released


API Tags:
Access:  public


[ Top ]
get_maintainer  [line 146]

  string get_maintainer( )

Gets maintainer


API Tags:
Access:  public


[ Top ]
get_url  [line 166]

  string get_url( )

Gets URL address of web page that contain more information about module


API Tags:
Access:  public


[ Top ]
set_description  [line 115]

  void set_description( string $description  )

Sets module description

Parameters:
string   $description: 

API Tags:
Access:  public


[ Top ]
set_hid  [line 91]

  void set_hid( string $hid  )

Sets module HID

Parameters:
string   $hid:  Must be alphanumeric, starting with letter, underscore allowed, 100 characters max

API Tags:
Access:  public


[ Top ]
set_id  [line 69]

  void set_id( integer $id  )

Sets module ID

Parameters:
integer   $id: 

API Tags:
Access:  public


[ Top ]
set_license  [line 176]

  void set_license( integer $license  )

Sets ID of the license under which module is released

Parameters:
integer   $license: 

API Tags:
Access:  public


[ Top ]
set_maintainer  [line 135]

  void set_maintainer( string $maintainer  )

Sets module maintainer email

Parameters:
string   $maintainer:  Valid email address

API Tags:
Access:  public


[ Top ]
set_url  [line 156]

  void set_url( string $url  )

Sets URL address of web page that contain more information about module

Parameters:
string   $url: 

API Tags:
Access:  public


[ Top ]