WebserviceAccessRule Class Reference

Inheritance diagram for WebserviceAccessRule:

Collaboration diagram for WebserviceAccessRule:

Public Member Functions
	__construct ($id=null)
	checkIpInRange ($check_ip)
	checkMethodName ($method)
Public Member Functions inherited from SimpleORMap
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toArrayRecursive ($depth=1, $only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	setData ($data, $reset=false)
	haveData ()
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	initRelation ($relation)
	resetRelation ($relation)

Static Public Member Functions
static	findByApiKey ($api_key)
static	findAll ()
static	checkAccess ($api_key, $method, $ip)
Static Public Member Functions inherited from SimpleORMap
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($where=1, $params=array())
static	create ($data)
static	import ($data)
static	findBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $where, $params=array())
static	findMany ($pks=array(), $order= '')
static	findEachMany ($callable, $pks=array(), $order= '')
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Protected Member Functions
	getIp_range ()
	setIp_range ($value)
Protected Member Functions inherited from SimpleORMap
	parseRelationOptions ($type, $name, $options)
	getTableScheme ()
	storeRelations ()
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()

Additional Inherited Members
Static Protected Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
Protected Attributes inherited from SimpleORMap
	$content = array()
	$content_db = array()
	$is_new = true
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$alias_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks
	$known_slots = array()
	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
Static Protected Attributes inherited from SimpleORMap
static	$schemes

Detailed Description

this class represents one record of the table webservice_access_rules the column ip_range is converted from a comma separated list to an ArrayObject and vice-versa, to allow array-like access

Example:

$rule = WebserviceAccessRule::find($id);
echo $rule['ip_range']; //prints out e.g. 127.0.0.1
$rule['ip_range'][] = '192.168.19.0/8';
echo $rule['ip_range']; //prints out 127.0.0.1,192.168.19.0/8

Constructor & Destructor Documentation

__construct

(

$id = null

)

Constructor

Parameters

string

$id

primary key of table

Reimplemented from SimpleORMap.

Here is the call graph for this function:

Member Function Documentation

static checkAccess (   $api_key,   $method,   $ip  )

static

Checks for given api key, methodname and IP Address if access is granted or not

Parameters

string	$api_key	an api key
string	$method	a name of an webservice method
string	$ip	an IP Address

Returns

boolean returns true if access fpr given params is allowed

Here is the call graph for this function:

Here is the caller graph for this function:

checkIpInRange

(

$check_ip

)

checks, if a given IP Address is in the range specified for this rule. If there is no specified range, it returns true

Parameters

string

$check_ip

an IP Address

Returns

boolean true if given Address is in specified range

Here is the call graph for this function:

checkMethodName

(

$method

)

checks, if the specified method name for this rule is part of the given one. If there is no specified method name, it returns true

Parameters

string

$method

a webservice method name

Returns

boolean true if given name matches the specified

static findAll ( )

static

returns all rules in db sorted by api key

Returns

array of WebserviceAccessRule objects

Here is the call graph for this function:

Here is the caller graph for this function:

static findByApiKey (   $api_key )

static

returns all rules for an given api key

Parameters

string

$api_key

Returns

array of WebserviceAccessRule objects

Here is the caller graph for this function:

getIp_range ( )

protected

setIp_range (   $value )

protected

---

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

• lib/models/WebserviceAccessRule.class.php