OssnComponents Class Reference
Inheritance diagram for OssnComponents:
OssnDatabase OssnBase

Public Member Functions

 getComponentsDir ()
 
 total ()
 
 getComponents ()
 
 upload ()
 
 newCom ($com)
 
 loadComs ()
 
 getActive ()
 
 isOld ($element)
 
 isActive ($id= '')
 
 enable ($com)
 
 delete ($com)
 
 requiredComponents ()
 
 DISABLE ($com=NULL)
 
 bundledComponents ()
 
 setSettings ($component, array $vars=array())
 
 setComSETTINGS ($component, $setting, $value)
 
 getSettings ($component)
 
 getComSettings ($component)
 
 getbyName ($name)
 
- Public Member Functions inherited from OssnDatabase
 Connect ()
 
 insert ($params)
 
 statement ($query)
 
 execute ()
 
 update ($params=array())
 
 select ($params, $multi= '')
 
 fetch ($data=false)
 
 delete ($params)
 
 getLastEntry ()
 
 constructWheres (array $array, $operator="AND")
 
 generateLimit ($data_limit=false, $page_limit=false, $offset=false)
 
- Public Member Functions inherited from OssnBase
 getGUID ()
 
 getID ()
 
 getParam ($param)
 
 isParam ($param)
 

Static Public Member Functions

static getCom ($name)
 
static checkRequirments ($element)
 

Detailed Description

Definition at line 11 of file OssnComponents.php.

Member Function Documentation

bundledComponents ( )

Bundled components

Returns
array

Definition at line 436 of file OssnComponents.php.

static checkRequirments (   $element)
static

Check component requirments

Parameters
string$elementA valid component xml file
Returns
false|array

Definition at line 226 of file OssnComponents.php.

delete (   $com)

Delete component

Returns
boolean

Definition at line 367 of file OssnComponents.php.

DISABLE (   $com = NULL)

Disable component

Returns
boolean

Definition at line 418 of file OssnComponents.php.

enable (   $com)

Enable Component

Returns
boolean

Definition at line 324 of file OssnComponents.php.

getActive ( )

Get active components

Returns
active components;

Definition at line 175 of file OssnComponents.php.

getbyName (   $name)

Get component

Note
This id is not a package id
Returns
integer|false;

Definition at line 537 of file OssnComponents.php.

static getCom (   $name)
static

Get component details

string $name Component id;

Returns
false|object

Definition at line 190 of file OssnComponents.php.

getComponents ( )

Get components list

Returns
array

Definition at line 48 of file OssnComponents.php.

getComponentsDir ( )

Get components from compnents directory

Returns
array

Definition at line 17 of file OssnComponents.php.

getComSettings (   $component)

Get Component Settings

string $component Component id

Note
This method is deprecated and will be removed in Ossn v4.0
Returns
false|array;

Definition at line 527 of file OssnComponents.php.

getSettings (   $component)

Get Component Settings

string $component Component id

Returns
false|array;

Definition at line 505 of file OssnComponents.php.

isActive (   $id = '')

Check if component is active or not

Returns
boolean

Definition at line 304 of file OssnComponents.php.

isOld (   $element)

Check if component is older than 3.x

Parameters
string$elementComponent xml string.
Returns
boolean

Definition at line 209 of file OssnComponents.php.

loadComs ( )

Load all active components

Returns
false|null startup files;

Definition at line 147 of file OssnComponents.php.

newCom (   $com)

Insert a new component to system

Returns
boolean

Definition at line 115 of file OssnComponents.php.

requiredComponents ( )

Required Components

Admin can't disable required components;

Returns
array

Definition at line 399 of file OssnComponents.php.

setComSETTINGS (   $component,
  $setting,
  $value 
)

Set component settings

Parameters
string$componentComponent id
string$settingSetting name
string$valueSetting value
Note
This method is deprecated and will be removed in Ossn v4.0
Returns
boolean

Definition at line 492 of file OssnComponents.php.

setSettings (   $component,
array  $vars = array() 
)

Set component settings

setSettings should have array() to accept values #434

Parameters
string$componentComponent id
arrayvars Setting (two-dem array)
Returns
boolean

Definition at line 458 of file OssnComponents.php.

total ( )

Count total components

Returns
integer

Definition at line 39 of file OssnComponents.php.

upload ( )

Upload component

Requires component package file,

Returns
boolean

Definition at line 67 of file OssnComponents.php.


The documentation for this class was generated from the following file: