classes/plflagset.php

   1 <?php
   2 /*
   3  * Copyright (C) 2003-2011 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 extends PlAbstractIterable implements XDBFormat, PlExportable
  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             if (!empty($part)) {
  43                 $this->values[$part] = true;
  44             }
  45         }
  46     }
  47
  48
  49     /** add flag
  50      * @param $flag name of the flag
  51      * @param $cond if true, add the flag (default is true), else, ignore.
  52      * @return VOID
  53      */
  54     public function addFlag($flag, $cond = true)
  55     {
  56         if (empty($flag) || !$cond) {
  57             return;
  58         }
  59         $this->values[$flag] = true;
  60     }
  61
  62
  63     /** test si flag ou pas
  64      * @param $flag XXX
  65      * @return 1 || 0
  66      */
  67     public function hasFlag($flag)
  68     {
  69         return !empty($flag) && isset($this->values[$flag]) && $this->values[$flag];
  70     }
  71
  72     /** test flag combination
  73      */
  74     public function hasFlagCombination($flag)
  75     {
  76         $perms = explode(',', $flag);
  77         foreach ($perms as $perm)
  78         {
  79             $ok = true;
  80             $rights = explode(':', $perm);
  81             foreach ($rights as $right) {
  82                 if (($right{0} == '!' && $this->hasFlag(substr($right, 1))) || !$this->hasFlag($right)) {
  83                     $ok = false;
  84                 }
  85             }
  86             if ($ok) {
  87                 return true;
  88             }
  89         }
  90         return false;
  91     }
  92
  93     /** remove flag
  94      * @param $flag XXX
  95      * @return VOID
  96      */
  97     public function rmFlag($flag)
  98     {
  99         if (empty($flag)) {
 100             return;
 101         }
 102         if (isset($this->values[$flag])) {
 103             unset($this->values[$flag]);
 104         }
 105     }
 106
 107     /** Remove all the flags.
 108      */
 109     public function clear()
 110     {
 111         $this->values = array();
 112     }
 113
 114
 115     /** return the PlFlagSet
 116      */
 117     public function flags()
 118     {
 119         $flags = '';
 120         foreach ($this->values as $key=>$value) {
 121             if (!empty($flags)) {
 122                 $flags .= $this->sep;
 123             }
 124             if ($value) {
 125                 $flags .= $key;
 126             }
 127         }
 128         return $flags;
 129     }
 130
 131     /** export the PlFlagSet
 132      */
 133     public function export()
 134     {
 135         $array = array();
 136         foreach ($this->values as $key=>$value) {
 137             if ($value) {
 138                 $array[] = $key;
 139             }
 140         }
 141         return $array;
 142     }
 143
 144     /** format for XDB
 145      */
 146     public function format()
 147     {
 148         return XDB::escape($this->flags());
 149     }
 150
 151
 152     /** Build an iterator for this PlFlagSet.
 153      */
 154     public function iterate()
 155     {
 156         return PlIteratorUtils::fromArray($this->export(), 1, true);
 157     }
 158 }
 159
 160 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 161 ?>