project/library/Pivip/Auth/Identity/Property.php

   1 <?php
   2
   3 /**
   4  * Pivip
   5  * Copyright (C) 2008  Vincent Tunru
   6
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  19  *
  20  * @license   http://www.fsf.org/licensing/licenses/info/GPLv2.html GPL v.2
  21  * @category  Pivip
  22  * @package   Pivip
  23  * @copyright (C) 2008 Vincent Tunru
  24  * @author    Vincent Tunru <email@vincentt.org>
  25  */
  26
  27 /**
  28  * Property of an identity
  29  *
  30  * @link http://www.ietf.org/rfc/rfc2426.txt RFC 2426, vCard MIME Directory
  31  *                                           profile.
  32  * @see /library/Pivip/Auth/Identity/Abstract.php
  33  */
  34 class Pivip_Auth_Identity_Property implements SeekableIterator, Countable
  35 {
  36         /**
  37          * @var array Property subproperties
  38          */
  39         private $_subProperties = array();
  40
  41         /**
  42          * @var string Value of the property
  43          */
  44         public $value;
  45
  46         /**
  47          * @var string Name of the property
  48          */
  49         public $name;
  50
  51         /**
  52          * Set a property, as well as optional sub-properties
  53          *
  54          * @param string $property      The property to set
  55          * @param mixed  $subProperties Provide an array to set sub-properties,
  56     *                              provide a string to just set the value
  57          */
  58         public function __construct($property, $subProperties)
  59         {
  60                 $this->name = strtolower($property);
  61                 $this->_subProperties = new ArrayObject();
  62
  63                 if('email' == $property)
  64                 {
  65                         if(is_string($subProperties))
  66                         {
  67                                 $this->value = $subProperties;
  68                                 $this->_subProperties = array('type' => 'internet',
  69                                                               'value' => $subProperties);
  70                         } else if(is_array($subProperties)) {
  71                                 if(empty($subProperties['type']))
  72                                 {
  73                                         $subProperties['type'] = 'internet';
  74                                 }
  75                                 $subProperties['type'] = strtolower($subProperties['type']);
  76                                 if(empty($subProperties['value']))
  77                                 {
  78                                         $values = $subProperties;
  79                                         unset($values['type']);
  80                                         $subProperties['value'] = implode('', $values);
  81                                 }
  82                                 $this->_subProperties = $subProperties;
  83                                 $this->value = $subProperties['value'];
  84                         } else {
  85                                 throw new InvalidArgumentException();
  86                         }
  87                         return;
  88                 }
  89
  90                 if('tel' == $property)
  91                 {
  92                         if(is_string($subProperties))
  93                         {
  94                                 $this->value = $subProperties;
  95                                 $this->_subProperties = array('type' => 'voice',
  96                                                               'value' => $subProperties);
  97                         } else if(is_array($subProperties))
  98                         {
  99                                 if(empty($subProperties['type']))
 100                                 {
 101                                         $subProperties['type'] = 'voice';
 102                                 }
 103                                 $subProperties['type'] = strtolower($subProperties['type']);
 104                                 if(empty($subProperties['value']))
 105                                 {
 106                                         $values = $subProperties;
 107                                         unset($values['type']);
 108                                         $subProperties['value'] = implode('', $values);
 109                                 }
 110                                 $this->_subProperties = $subProperties;
 111                                 $this->value = $subProperties['value'];
 112                         } else {
 113                                 throw new InvalidArgumentException();
 114                         }
 115                         return;
 116                 }
 117
 118                 if('adr' == $property)
 119                 {
 120                         $components = array('post-office-box', 'extended-address',
 121                                             'street-address', 'locality', 'region',
 122                                             'postal-code', 'country-name', 'type');
 123                         if(is_string($subProperties))
 124                         {
 125                                 $this->value = $subProperties;
 126                                 $values = explode(';', $subProperties);
 127                                 foreach($values as $i => $subProperty)
 128                                 {
 129                                         $this->_subProperties[$components[$i]] = $subProperty;
 130                                 }
 131                         } else if(is_array($subProperties))
 132                         {
 133                                 $value = '';
 134                                 foreach($components as $component)
 135                                 {
 136                                         if(!empty($subProperties[$component]))
 137                                         {
 138                                                 $value .= $subProperties[$component];
 139                                         }
 140                                         $value .= ';';
 141                                 }
 142                                 $this->value = $value;
 143                                 $this->_subProperties = $subProperties;
 144                         } else {
 145                                 throw new InvalidArgumentException();
 146                         }
 147                         return;
 148                 }
 149
 150                 if('geo' == $property)
 151                 {
 152                         if(is_string($subProperties))
 153                         {
 154                                 if(false === strpos($subProperties, ';'))
 155                                 {
 156                                         throw new InvalidArgumentException();
 157                                 }
 158                                 $values = explode(';', $subProperties);
 159                                 $this->value = $subProperties;
 160                                 $this->_subProperties = array('latitude' => $values[0],
 161                                                               'longitude' => $values[1]);
 162                         } else if(is_array($subProperties))
 163                         {
 164                                 if(empty($subProperties['latitude']) ||
 165                                    empty($subProperties['longitude']))
 166                                 {
 167                                         throw new InvalidArgumentException();
 168                                 }
 169                                 $this->value = $subProperties['latitude'] . ';' .
 170                                                $subProperties['longitude'];
 171                                 $this->_subProperties = $subProperties;
 172                         } else {
 173                                 throw new InvalidArgumentException();
 174                         }
 175                         return;
 176                 }
 177
 178                 if('org' == $property)
 179                 {
 180                         if(is_string($subProperties))
 181                         {
 182                                 $this->value = $subProperties;
 183                                 $this->_subProperties = array('organization-name' =>
 184                                                                 $subProperties);
 185                         } else if(is_array($subProperties))
 186                         {
 187                                 if(empty($subProperties['organization-name']))
 188                                 {
 189                                         $subProperties['organization-name'] = implode('',
 190                                                                                       $subProperties);
 191                                 }
 192                                 $this->_subProperties = $subProperties;
 193                                 $this->value = $subProperties['organization-name'];
 194                         } else {
 195                                 throw new InvalidArgumentException();
 196                         }
 197                         return;
 198                 }
 199
 200                 if(is_string($subProperties))
 201                 {
 202                         $this->value = $subProperties;
 203                 } else if(is_array($subProperties)) {
 204                         $this->_subProperties = $subProperties;
 205                         $this->value = implode(';', $subProperties);
 206                 } else {
 207                         throw new InvalidArgumentException();
 208                 }
 209         }
 210
 211         /**
 212          * Retrieve a sub-property
 213          *
 214          * @param  string $subProperty Name of the sub-property to retrieve.
 215          * @return string Value of the sub-property
 216          */
 217         public function __get($subProperty)
 218         {
 219                 if(isset($this->_subProperties[$subProperty]))
 220                 {
 221                         return $this->_subProperties[$subProperty];
 222                 }
 223                 return '';
 224         }
 225
 226         /**
 227          * Set a sub-property
 228          *
 229          * @param  string $subProperty Name of the sub-property to set.
 230          * @param  string $value Value of the sub-property
 231          */
 232         public function __set($subProperty, $value)
 233         {
 234                 if(!is_string($subProperty) || !is_string($value))
 235                 {
 236                         throw new InvalidArgumentException();
 237                 }
 238                 $this->_subProperties[$subProperty] = $value;
 239         }
 240
 241         /**
 242          * Check whether a sub-property is set
 243          *
 244          * @param  string  $subProperty Name of the sub-property to check
 245          * @return boolean Whether the sub-property is set.
 246          */
 247         public function __isset($subProperty)
 248         {
 249                 return isset($this->_subProperties[$subProperty]);
 250         }
 251
 252         /**
 253          * Unset a sub-property
 254          *
 255          * @param string $subProperty Name of the sub-property to unset
 256          * @return void
 257          */
 258         public function __unset($subProperty)
 259         {
 260                 unset($this->_subProperties[$subProperty]);
 261         }
 262
 263         /**
 264          * The current value
 265          *
 266          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 267          */
 268         public function current()
 269         {
 270                 return current($this->_subProperties);
 271         }
 272
 273         /**
 274          * The current key
 275          *
 276          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 277          */
 278         public function key()
 279         {
 280                 return key($this->_subProperties);
 281         }
 282
 283         /**
 284          * Move the pointer forward
 285          *
 286          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 287          */
 288         public function next()
 289         {
 290                 next($this->_subProperties);
 291         }
 292
 293         /**
 294          * Rewind the pointer
 295          *
 296          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 297          */
 298         public function rewind()
 299         {
 300                 reset($this->_subProperties);
 301         }
 302
 303         /**
 304          * Get a specific value
 305          *
 306          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 307          * @param mixed $index Index of the value to retrieve
 308          */
 309         public function seek($index)
 310         {
 311                 return $this->__get($index);
 312         }
 313
 314         /**
 315          * Check whether the current index is valid
 316          *
 317          * @link http://www.php.net/~helly/php/ext/spl/interfaceSeekableIterator.html
 318          */
 319         public function valid()
 320         {
 321                 return (false !== current($this->_subProperties));
 322         }
 323
 324         /**
 325          * Count the number of subproperties
 326          *
 327          * @link http://www.php.net/~helly/php/ext/spl/interfaceCountable.html
 328          */
 329         public function count()
 330         {
 331                 return count($this->_subProperties);
 332         }
 333 }