vendor/adldap2/adldap2/src/Models/Attributes/Guid.php

   1 <?php
   2
   3 namespace Adldap\Models\Attributes;
   4
   5 use Adldap\Utilities;
   6 use InvalidArgumentException;
   7
   8 class Guid
   9 {
  10     /**
  11      * The string GUID value.
  12      *
  13      * @var string
  14      */
  15     protected $value;
  16
  17     /**
  18      * The guid structure in order by section to parse using substr().
  19      *
  20      * @author Chad Sikorra <Chad.Sikorra@gmail.com>
  21      * @link https://github.com/ldaptools/ldaptools
  22      *
  23      * @var array
  24      */
  25     protected $guidSections = [
  26         [[-26, 2], [-28, 2], [-30, 2], [-32, 2]],
  27         [[-22, 2], [-24, 2]],
  28         [[-18, 2], [-20, 2]],
  29         [[-16, 4]],
  30         [[-12, 12]],
  31     ];
  32
  33     /**
  34      * The hexadecimal octet order based on string position.
  35      *
  36      * @author Chad Sikorra <Chad.Sikorra@gmail.com>
  37      * @link https://github.com/ldaptools/ldaptools
  38      *
  39      * @var array
  40      */
  41     protected $octetSections = [
  42         [6, 4, 2 ,0],
  43         [10, 8],
  44         [14, 12],
  45         [16, 18, 20, 22, 24, 26, 28, 30]
  46     ];
  47
  48     /**
  49      * Determines if the specified GUID is valid.
  50      *
  51      * @param string $guid
  52      *
  53      * @return bool
  54      */
  55     public static function isValid($guid)
  56     {
  57         return Utilities::isValidGuid($guid);
  58     }
  59
  60     /**
  61      * Constructor.
  62      *
  63      * @param mixed $value
  64      *
  65      * @throws InvalidArgumentException
  66      */
  67     public function __construct($value)
  68     {
  69         if (static::isValid($value)) {
  70             $this->value = $value;
  71         } else if ($value = $this->binaryGuidToString($value)) {
  72             $this->value = $value;
  73         } else {
  74             throw new InvalidArgumentException("Invalid Binary / String GUID.");
  75         }
  76     }
  77
  78     /**
  79      * Returns the string value of the GUID.
  80      *
  81      * @return string
  82      */
  83     public function __toString()
  84     {
  85         return $this->getValue();
  86     }
  87
  88     /**
  89      * Returns the string value of the SID.
  90      *
  91      * @return string
  92      */
  93     public function getValue()
  94     {
  95         return $this->value;
  96     }
  97
  98     /**
  99      * Get the binary representation of the GUID string.
 100      *
 101      * @return string
 102      */
 103     public function getBinary()
 104     {
 105         $data = '';
 106
 107         $guid = str_replace('-', '', $this->value);
 108
 109         foreach ($this->octetSections as $section) {
 110             $data .= $this->parseSection($guid, $section, true);
 111         }
 112
 113         return hex2bin($data);
 114     }
 115
 116     /**
 117      * Returns the string variant of a binary GUID.
 118      *
 119      * @param string $binary
 120      *
 121      * @return string|null
 122      */
 123     protected function binaryGuidToString($binary)
 124     {
 125         return Utilities::binaryGuidToString($binary);
 126     }
 127
 128     /**
 129      * Return the specified section of the hexadecimal string.
 130      *
 131      * @author Chad Sikorra <Chad.Sikorra@gmail.com>
 132      * @link https://github.com/ldaptools/ldaptools
 133      *
 134      * @param string $hex      The full hex string.
 135      * @param array  $sections An array of start and length (unless octet is true, then length is always 2).
 136      * @param bool   $octet    Whether this is for octet string form.
 137      *
 138      * @return string The concatenated sections in upper-case.
 139      */
 140     protected function parseSection($hex, array $sections, $octet = false)
 141     {
 142         $parsedString = '';
 143
 144         foreach ($sections as $section) {
 145             $start = $octet ? $section : $section[0];
 146
 147             $length = $octet ? 2 : $section[1];
 148
 149             $parsedString .= substr($hex, $start, $length);
 150         }
 151
 152         return $parsedString;
 153     }
 154 }