lib/CrEOF/Spatial/DBAL/Platform/PlatformInterface.php
<?php
/**
* Copyright (C) 2015 Derek J. Lambert
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
namespace CrEOF\Spatial\DBAL\Platform;
use CrEOF\Spatial\DBAL\Types\AbstractSpatialType;
use CrEOF\Spatial\PHP\Types\Geometry\GeometryInterface;
/**
* Spatial platform interface
*
* @author Derek J. Lambert <dlambert@dereklambert.com>
* @license http://dlambert.mit-license.org MIT
*/
interface PlatformInterface
{
/**
* @param AbstractSpatialType $type
* @param string $sqlExpr
*
* @return GeometryInterface
*/
public function convertBinaryToPHPValue(AbstractSpatialType $type, $sqlExpr);
/**
* @param AbstractSpatialType $type
* @param string $sqlExpr
*
* @return GeometryInterface
*/
public function convertStringToPHPValue(AbstractSpatialType $type, $sqlExpr);
/**
* @param AbstractSpatialType $type
* @param GeometryInterface $value
*
* @return string
*/
public function convertToDatabaseValue(AbstractSpatialType $type, GeometryInterface $value);
/**
* @param AbstractSpatialType $type
* @param string $sqlExpr
*
* @return string
*/
public function convertToDatabaseValueSQL(AbstractSpatialType $type, $sqlExpr);
/**
* @param AbstractSpatialType $type
* @param string $sqlExpr
*
* @return string
*/
public function convertToPHPValueSQL(AbstractSpatialType $type, $sqlExpr);
/**
* Gets the SQL declaration snippet for a field of this type.
*
* @param array $fieldDeclaration
*
* @return string
*/
public function getSQLDeclaration(array $fieldDeclaration);
/**
* @param AbstractSpatialType $type
*
* @return string[]
*/
public function getMappedDatabaseTypes(AbstractSpatialType $type);
}