Stud.IP  2.3 Revision 48548
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
WebserviceAccessRule Class Reference
Inheritance diagram for WebserviceAccessRule:
Inheritance graph
Collaboration diagram for WebserviceAccessRule:
Collaboration graph

Public Member Functions

 __construct ($id=null)
 setData ($data, $reset)
 setValue ($field, $value)
 getNewId ()
 checkIpInRange ($check_ip)
 checkMethodName ($method)
- Public Member Functions inherited from SimpleORMap
 getTableMetadata ()
 setId ($id)
 getId ()
 getData ()
 toArray ()
 getValue ($field)
 __get ($field)
 __set ($field, $value)
 __isset ($field)
 offsetExists ($offset)
 offsetGet ($offset)
 offsetSet ($offset, $value)
 offsetUnset ($offset)
 getIterator ()
 count ()
 isField ($field)
 haveData ()
 isNew ()
 setNew ($is_new)
 getWhereQuery ()
 restore ()
 store ()
 triggerChdate ()
 delete ()
 isDirty ()
 isFieldDirty ($field)
 revertValue ($field)

Static Public Member Functions

static find ($id)
static findBySql ($where)
static findByApiKey ($api_key)
static findAll ()
static deleteBySql ($where)
static checkAccess ($api_key, $method, $ip)
- Static Public Member Functions inherited from SimpleORMap
static expireTableScheme ()
static find ($class, $id)
static findBySQL ($class, $where)
static deleteBySQL ($class, $where)
static toObject ($class, $id_or_object)

Additional Inherited Members

- Protected Member Functions inherited from SimpleORMap
 getTableScheme ()
 initializeContent ()
- 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()
- 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$idprimary 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_keyan api key
string$methoda name of an webservice method
string$ipan 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_ipan 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$methoda webservice method name
Returns
boolean true if given name matches the specified
static deleteBySql (   $where)
static
See Also
SimpleORMap::deleteBySql()
static find (   $id)
static
See Also
SimpleORMap::find()
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 call graph for this function:

Here is the caller graph for this function:

static findBySql (   $where)
static
See Also
SimpleORMap::findBySql()
getNewId ( )

the table uses an auto_increment as primary key, so this always return 0 to get new key on first insert

Returns
integer always 0

Reimplemented from SimpleORMap.

setData (   $data,
  $reset 
)
See Also
SimpleORMap::setData()

Reimplemented from SimpleORMap.

setValue (   $field,
  $value 
)
See Also
SimpleORMap::setValue()

Reimplemented from SimpleORMap.

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