classes/plflagset.php

   1 <?php
   2 /*
   3  * Copyright (C) 2003-2008 Polytechnique.org
   4  * http://opensource.polytechnique.org/
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21
  22 /** class for describing flags
  23  */
  24 class PlFlagSet
  25 {
  26     /** string that holds the PlFlagSet */
  27     private $values = array();
  28
  29     /** the boundary between flags */
  30     private $sep;
  31
  32
  33     /** set flag
  34      * @param $flags services FROM coupures
  35      * @return VOID
  36      */
  37     public function __construct($flags = '', $sep = ',')
  38     {
  39         $this->sep = $sep;
  40         $splitted = explode($sep, $flags);
  41         foreach ($splitted as $part) {
  42             $this->values[$part] = true;
  43         }
  44     }
  45
  46
  47     /** add flag
  48      * @param $flag name of the flag
  49      * @param $cond if true, add the flag (default is true), else, ignore.
  50      * @return VOID
  51      */
  52     public function addFlag($flag, $cond = true)
  53     {
  54         if (empty($flag) || !$cond) {
  55             return;
  56         }
  57         $this->values[$flag] = true;
  58     }
  59
  60
  61     /** test si flag ou pas
  62      * @param $flag XXX
  63      * @return 1 || 0
  64      */
  65     public function hasFlag($flag)
  66     {
  67         return !empty($flag) && isset($this->values[$flag]) && $this->values[$flag];
  68     }
  69
  70     /** test flag combination
  71      */
  72     public function hasFlagCombination($flag)
  73     {
  74         $perms = explode(',', $flag);
  75         foreach ($perms as $perm)
  76         {
  77             $ok = true;
  78             $rights = explode(':', $perm);
  79             foreach ($rights as $right) {
  80                 if (($right{0} == '!' && $this->hasFlag(substr($right, 1))) || !$this->hasFlag($right)) {
  81                     $ok = false;
  82                 }
  83             }
  84             if ($ok) {
  85                 return true;
  86             }
  87         }
  88         return false;
  89     }
  90
  91     /** remove flag
  92      * @param $flag XXX
  93      * @return VOID
  94      */
  95     public function rmFlag($flag)
  96     {
  97         if (empty($flag)) {
  98             return;
  99         }
 100         if (isset($this->values[$flag])) {
 101             unset($this->values[$flag]);
 102         }
 103     }
 104
 105
 106     /** return the PlFlagSet
 107      */
 108     public function flags()
 109     {
 110         $flags = '';
 111         foreach ($this->values as $key=>$value) {
 112             if (!empty($flags)) {
 113                 $flags .= $this->sep;
 114             }
 115             if ($value) {
 116                 $flags .= $key;
 117             }
 118         }
 119         return $flags;
 120     }
 121 }
 122
 123 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 124 ?>