Alcaeus\MongoDbAdapter\TypeConverter

Complexity

Total Complexity

24

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	9

Test Coverage

Coverage

71.19%

Importance

Changes	7
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
B	convertFromLegacy()	0	18	5
B	convertToLegacy()	0	18	5
A	isNumericArray()	0	4	2
C	convertBSONObjectToLegacy()	0	23	9
A	ensureCorrectType()	0	15	3

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Alcaeus\MongoDbAdapter;

/**
 * @internal
 */
class TypeConverter
{
    /**
     * Converts a legacy type to the new BSON type
     *
     * This method handles type conversion from ext-mongo to ext-mongodb:
     *  - For all types (MongoId, MongoDate, etc.) it returns the correct BSON
     *    object instance
     *  - For arrays and objects it iterates over properties and converts each
     *    item individually
     *  - For other types it returns the value unconverted
     *
     * @param mixed $value
     * @return mixed
     */
    public static function convertFromLegacy($value)
    {
        switch (true) {
            case $value instanceof TypeInterface:
                return $value->toBSONType();
            case is_array($value):
            case is_object($value);

case statements should not use curly braces.

                $result = [];

                foreach ($value as $key => $item) {
                    $result[$key] = self::convertFromLegacy($item);
                }

                return self::ensureCorrectType($result);
            default:
                return $value;
        }
    }

    /**
     * Converts a BSON type to the legacy types
     *
     * This method handles type conversion from ext-mongodb to ext-mongo:
     *  - For all instances of \MongoDB\BSON\Type it returns an object of the
     *    corresponding legacy type (MongoId, MongoDate, etc.)
     *  - For arrays and objects it iterates over properties and converts each
     *    item individually
     *  - For other types it returns the value unconverted
     *
     * @param mixed $value
     * @return mixed
     */
    public static function convertToLegacy($value)
    {
        switch (true) {
            case $value instanceof \MongoDB\BSON\Type:

The class MongoDB\BSON\Type does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return self::convertBSONObjectToLegacy($value);
            case is_array($value):
            case is_object($value):
                $result = [];

                foreach ($value as $key => $item) {
                    $result[$key] = self::convertToLegacy($item);
                }

                return $result;
            default:
                return $value;
        }
    }

    /**
     * Helper method to find out if an array has numerical indexes
     *
     * For performance reason, this method checks the first array index only.
     * More thorough inspection of the array might be needed.
     * Note: Returns true for empty arrays to preserve compatibility with empty
     * lists.
     *
     * @param array $array
     * @return bool
     */
    public static function isNumericArray(array $array)
    {
        return $array === [] || is_numeric(array_keys($array)[0]);
    }

    /**
     * Converter method to convert a BSON object to its legacy type
     *
     * @param \MongoDB\BSON\Type $value
     * @return mixed
     */
    private static function convertBSONObjectToLegacy(\MongoDB\BSON\Type $value)
    {
        switch (true) {
            case $value instanceof \MongoDB\BSON\ObjectID:

The class MongoDB\BSON\ObjectID does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoId($value);
            case $value instanceof \MongoDB\BSON\Binary:

The class MongoDB\BSON\Binary does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoBinData($value);
            case $value instanceof \MongoDB\BSON\Javascript:

The class MongoDB\BSON\Javascript does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoCode($value);
            case $value instanceof \MongoDB\BSON\MaxKey:

The class MongoDB\BSON\MaxKey does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoMaxKey();
            case $value instanceof \MongoDB\BSON\MinKey:

The class MongoDB\BSON\MinKey does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoMinKey();
            case $value instanceof \MongoDB\BSON\Regex:

The class MongoDB\BSON\Regex does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoRegex($value);
            case $value instanceof \MongoDB\BSON\Timestamp:

The class MongoDB\BSON\Timestamp does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoTimestamp($value);
            case $value instanceof \MongoDB\BSON\UTCDatetime:

The class MongoDB\BSON\UTCDatetime does not exist. Did you forget a USE statement, or did you not list all dependencies?

                return new \MongoDate($value);
            default:
                return $value;
        }
    }

    /**
     * Converts all arrays with non-numeric keys to stdClass
     *
     * @param array $array
     * @return array|\stdClass
     */
    private static function ensureCorrectType(array $array)
    {
        // Empty arrays are left untouched since they may be an empty list or empty document
        if (static::isNumericArray($array)) {
            return $array;
        }

        // Can convert array to stdClass
        $object = new \stdClass();
        foreach ($array as $key => $value) {
            $object->$key = $value;
        }

        return $object;
    }
}