<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Handles the binary to IPv4/IPv6 transformation for text plain
 *
 * @package    PhpMyAdmin-Transformations
 * @subpackage BinaryToIP
 */
namespace PMA\libraries\plugins\transformations\output;

use PMA\libraries\plugins\TransformationsPlugin;

/**
 * Handles the binary to IPv4/IPv6 transformation for text plain
 *
 * @package    PhpMyAdmin-Transformations
 * @subpackage BinaryToIP
 */
class Text_Plain_Binarytoip extends TransformationsPlugin
{
    /**
     * Gets the transformation description of the plugin
     *
     * @return string
     */
    public static function getInfo()
    {
        return __(
            'Converts an Internet network address stored as a binary string'
            . ' into a string in Internet standard (IPv4/IPv6) format.'
        );
    }

    /**
     * Does the actual work of each specific transformations plugin.
     *
     * @param string $buffer  text to be transformed. a binary string containing
     *                        an IP address, as returned from MySQL's INET6_ATON
     *                        function
     * @param array  $options transformation options
     * @param string $meta    meta information
     *
     * @return string IP address
     */
    public function applyTransformation($buffer, $options = array(), $meta = '')
    {
        $length = strlen($buffer);
        if ($length == 4 || $length == 16) {
            $val = @inet_ntop(pack('A' . $length, $buffer));
            if ($val !== false) {
                return $val;
            }
        }

        return $buffer;
    }


    /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */

    /**
     * Gets the transformation name of the plugin
     *
     * @return string
     */
    public static function getName()
    {
        return "Binary To IPv4/IPv6";
    }

    /**
     * Gets the plugin`s MIME type
     *
     * @return string
     */
    public static function getMIMEType()
    {
        return "Text";
    }

    /**
     * Gets the plugin`s MIME subtype
     *
     * @return string
     */
    public static function getMIMESubtype()
    {
        return "Plain";
    }
}