ObjectPool_Model Class Reference

The univese of a objects of a given type in livestatus. More...

Inheritance diagram for ObjectPool_Model:
BaseObjectPool_Model BaseAuthModulePool_Model BaseColumnPool_Model BaseCommandPool_Model BaseCommentPool_Model BaseContactGroupPool_Model BaseContactPool_Model BaseDashboard_WidgetPool_Model BaseDashboardPool_Model BaseDowntimePool_Model BaseHostGroupPool_Model BaseHostPool_Model BaseNinja_WidgetPool_Model BaseNotificationPool_Model BasePermissionQuarkPool_Model BaseRecurringDowntimePool_Model BaseSavedFilterPool_Model BaseSavedReportPool_Model BaseServiceGroupPool_Model BaseServicePool_Model BaseSettingPool_Model BaseStatusPool_Model BaseTestClassAPool_Model BaseTestClassBPool_Model BaseTimePeriodPool_Model BaseUserGroupPool_Model BaseUserPool_Model

Public Member Functions

 available_for ($where)
 Check if a table is available to read and export from a given interface.
 get_by_name ($name, $disabled_saved_queries=array())
 Get a set of object, given a named query.

Static Public Member Functions

static get_by_query ($query, $disabled_saved_queries=array())
 Parse a query and return the related set.
static load_table_classes ()
 Get classes for tables in the system.

Static Protected Attributes

static $available_for
 List which places this object is available for.

Detailed Description

The univese of a objects of a given type in livestatus.


Member Function Documentation

ObjectPool_Model::available_for ( where  ) 

Check if a table is available to read and export from a given interface.

This can be used to hide tables from the HTTP-API that isn't API-stable enough yet.

ObjectPool_Model::get_by_name ( name,
disabled_saved_queries = array() 
)

Get a set of object, given a named query.

Can be overridden to handle groups (in HostPool/ServicePool)

Reimplemented in HostPool_Model, and ServicePool_Model.


Field Documentation

ObjectPool_Model::$available_for [static, protected]
Initial value:
 array(
                'api' => true
        )

List which places this object is available for.

It is (for now) always available within ninja. Other places are: api

Reimplemented in SavedReportPool_Model.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1