vendor/doctrine/dbal/lib/Doctrine/DBAL/Types/JsonArrayType.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\DBAL\Types;
  21
  22 use Doctrine\DBAL\Platforms\AbstractPlatform;
  23
  24 /**
  25  * Array Type which can be used to generate json arrays.
  26  *
  27  * @since 2.3
  28  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  29  */
  30 class JsonArrayType extends Type
  31 {
  32     public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
  33     {
  34         return $platform->getClobTypeDeclarationSQL($fieldDeclaration);
  35     }
  36
  37     public function convertToDatabaseValue($value, AbstractPlatform $platform)
  38     {
  39         if (null === $value) {
  40             return null;
  41         }
  42
  43         return json_encode($value);
  44     }
  45
  46     public function convertToPHPValue($value, AbstractPlatform $platform)
  47     {
  48         if ($value === null) {
  49             return array();
  50         }
  51
  52         $value = (is_resource($value)) ? stream_get_contents($value) : $value;
  53
  54         return json_decode($value, true);
  55     }
  56
  57     public function getName()
  58     {
  59         return Type::JSON_ARRAY;
  60     }
  61
  62     public function requiresSQLCommentHint(AbstractPlatform $platform)
  63     {
  64         return true;
  65     }
  66 }