.
Gyro-PHP > Documentation

PolicyHolder Class Reference
[Lib]

Class holding a policy (bitflags). More...

Inheritance diagram for PolicyHolder:
IPolicyHolder DBConstraint GSiteMapModel DBConstraintUnique

List of all members.

Public Member Functions
  __construct ($policy=self::NONE)
  Constructor.
  get_policy ()
  Return policy.
  has_policy ($policy)
  Returns true, if client has given policy.
  set_policy ($policy)
  Set policy.

Protected Attributes
  $policy = self::NONE

Detailed Description

Class holding a policy (bitflags).

Author:
Gerd Riesselmann

Definition at line 8 of file policyholder.cls.php.

Constructor & Destructor Documentation

PolicyHolder::__construct ( $  policy = self::NONE  ) 

Constructor.

Parameters:
int  $policy

Definition at line 16 of file policyholder.cls.php.

00016                                                         {
00017                 $this->policy = $policy;
00018         }

Member Function Documentation

PolicyHolder::get_policy (  ) 

Return policy.

Returns:
int

Implements IPolicyHolder.

Definition at line 25 of file policyholder.cls.php.

00025                                      {
00026                 return $this->policy;
00027         }
PolicyHolder::has_policy ( $  policy  ) 

Returns true, if client has given policy.

Parameters:
int  $policy
Returns:
bool

Implements IPolicyHolder.

Definition at line 44 of file policyholder.cls.php.

00044                                             {
00045                 return Common::flag_is_set($this->get_policy(), $policy);
00046         }
PolicyHolder::set_policy ( $  policy  ) 

Set policy.

Parameters:
int  $policy

Implements IPolicyHolder.

Definition at line 34 of file policyholder.cls.php.

00034                                             {
00035                 $this->policy = $policy;
00036         }

Member Data Documentation

PolicyHolder::$policy = self::NONE [protected]

Definition at line 9 of file policyholder.cls.php.

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