collecthor / spss

src/Sav/Variable.php

<?php

namespace SPSS\Sav;

use SPSS\Utils;

class Variable
{
    // const TYPE_NUMERIC = 1;
    // const TYPE_STRING = 2;

    const FORMAT_TYPE_A = 1;
    const FORMAT_TYPE_AHEX = 2;
    const FORMAT_TYPE_COMMA = 3;
    const FORMAT_TYPE_DOLLAR = 4;
    const FORMAT_TYPE_F = 5;
    const FORMAT_TYPE_IB = 6;
    const FORMAT_TYPE_PIBHEX = 7;
    const FORMAT_TYPE_P = 8;
    const FORMAT_TYPE_PIB = 9;
    const FORMAT_TYPE_PK = 10;
    const FORMAT_TYPE_RB = 11;
    const FORMAT_TYPE_RBHEX = 12;
    const FORMAT_TYPE_Z = 15;
    const FORMAT_TYPE_N = 16;
    const FORMAT_TYPE_E = 17;
    const FORMAT_TYPE_DATE = 20;
    const FORMAT_TYPE_TIME = 21;
    const FORMAT_TYPE_DATETIME = 22;
    const FORMAT_TYPE_ADATE = 23;
    const FORMAT_TYPE_JDATE = 24;
    const FORMAT_TYPE_DTIME = 25;
    const FORMAT_TYPE_WKDAY = 26;
    const FORMAT_TYPE_MONTH = 27;
    const FORMAT_TYPE_MOYR = 28;
    const FORMAT_TYPE_QYR = 29;
    const FORMAT_TYPE_WKYR = 30;
    const FORMAT_TYPE_PCT = 31;
    const FORMAT_TYPE_DOT = 32;
    const FORMAT_TYPE_CCA = 33;
    const FORMAT_TYPE_CCB = 34;
    const FORMAT_TYPE_CCC = 35;
    const FORMAT_TYPE_CCD = 36;
    const FORMAT_TYPE_CCE = 37;
    const FORMAT_TYPE_EDATE = 38;
    const FORMAT_TYPE_SDATE = 39;

    const ALIGN_LEFT = 0;
    const ALIGN_RIGHT = 1;
    const ALIGN_CENTER = 2;

    const MEASURE_UNKNOWN = 0;
    const MEASURE_NOMINAL = 1;
    const MEASURE_ORDINAL = 2;
    const MEASURE_SCALE = 3;

    const ROLE_INPUT = 0;
    const ROLE_TARGET = 1;
    const ROLE_BOTH = 2;
    const ROLE_NONE = 3;
    const ROLE_PARTITION = 4;
    const ROLE_SPLIT = 5;

    private $name;
    private $width = 8;
    public $decimals = 0;
    public $format = 0;
    public $columns;
    public $alignment;
    public $measure;
    public $role;
    public $label;
    public $values = [];
    public $missing = [];

    /**
     * @var array
     */
    public $attributes = [
        // '$@Role' => self::ROLE_BOTH
    ];

    /**
     * @var array
     */
    public $data = [];

    /**
     * Variable constructor.
     *
     * @param array $data
     */
    public function __construct(string $name, $data = [])
    {
        foreach ($data as $key => $value) {
            $this->{$key} = $value;
        }
        $this->name = $name;
    }

    public function setName(string $name)

The parameter $name is not used and could be removed.

    {
        #if (! preg_match('/^[A-Za-z0-9_]+$/', $var->name)) {
        # UTF-8 and '.' characters could pass here
        if (! preg_match('/^[A-Za-z0-9_\.\x{4e00}-\x{9fa5}]+$/u', $this->name)) {
            throw new \InvalidArgumentException(
                sprintf('Variable name `%s` contains an illegal character.', $this->name)
            );
        }
    }

    public function setWidth(int $width)
    {
        if ($width <= 0) {
            throw new \InvalidArgumentException(
                sprintf('Invalid field width. Should be an integer number greater than zero.')
            );
        }
        $this->width = $width;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getWidth(): int
    {
        return $this->width;
    }

    public function getOcts(): int
    {
        return Utils::widthToOcts($this->width);
    }

    /**
     * @param int $format
     * @return bool
     */
    public static function isNumberFormat($format)
    {
        return in_array($format, [
            self::FORMAT_TYPE_COMMA,
            self::FORMAT_TYPE_F,
            self::FORMAT_TYPE_DATETIME
        ]);
    }

    /**
     * This method returns the print / write format code of a variable.
     * The returned value is a tuple consisting of the format abbreviation
     * (string <= 8 chars) and a meaning (long string).
     * Non-existent codes have a (null, null) tuple returned.
     *
     * @param integer $format
     * @return array
     */
    public static function getFormatInfo($format)
    {
        switch ($format) {
            case 0:
                return ['', 'Continuation of string variable'];
            case self::FORMAT_TYPE_A:
                return ['A', 'Alphanumeric'];
            case self::FORMAT_TYPE_AHEX:
                return ['AHEX', 'alphanumeric hexadecimal'];
            case self::FORMAT_TYPE_COMMA:
                return ['COMMA', 'F format with commas'];
            case self::FORMAT_TYPE_DOLLAR:
                return ['DOLLAR', 'Commas and floating point dollar sign'];
            case self::FORMAT_TYPE_F:
                return ['F', 'F (default numeric) format'];
            case self::FORMAT_TYPE_IB:
                return ['IB', 'Integer binary'];
            case self::FORMAT_TYPE_PIBHEX:
                return ['PIBHEX', 'Positive binary integer - hexadecimal'];
            case self::FORMAT_TYPE_P:
                return ['P', 'Packed decimal'];
            case self::FORMAT_TYPE_PIB:
                return ['PIB', 'Positive integer binary (Unsigned)'];
            case self::FORMAT_TYPE_PK:
                return ['PK', 'Positive packed decimal (Unsigned)'];
            case self::FORMAT_TYPE_RB:
                return ['RB', 'Floating point binary'];
            case self::FORMAT_TYPE_RBHEX:
                return ['RBHEX', 'Floating point binary - hexadecimal'];
            case self::FORMAT_TYPE_Z:
                return ['Z', 'Zoned decimal'];
            case self::FORMAT_TYPE_N:
                return ['N', 'N format - unsigned with leading zeros'];
            case self::FORMAT_TYPE_E:
                return ['E', 'E format - with explicit power of ten'];
            case self::FORMAT_TYPE_DATE:
                return ['DATE', 'Date format dd-mmm-yyyy'];
            case self::FORMAT_TYPE_TIME:
                return ['TIME', 'Time format hh:mm:ss.s'];
            case self::FORMAT_TYPE_DATETIME:
                return ['DATETIME', 'Date and time'];
            case self::FORMAT_TYPE_ADATE:
                return ['ADATE', 'Date in mm/dd/yyyy form'];
            case self::FORMAT_TYPE_JDATE:
                return ['JDATE', 'Julian date - yyyyddd'];
            case self::FORMAT_TYPE_DTIME:
                return ['DTIME', 'Date-time dd hh:mm:ss.s'];
            case self::FORMAT_TYPE_WKDAY:
                return ['WKDAY', 'Day of the week'];
            case self::FORMAT_TYPE_MONTH:
                return ['MONTH', 'Month'];
            case self::FORMAT_TYPE_MOYR:
                return ['MOYR', 'mmm yyyy'];
            case self::FORMAT_TYPE_QYR:
                return ['QYR', 'q Q yyyy'];
            case self::FORMAT_TYPE_WKYR:
                return ['WKYR', 'ww WK yyyy'];
            case self::FORMAT_TYPE_PCT:
                return ['PCT', 'Percent - F followed by "%"'];
            case self::FORMAT_TYPE_DOT:
                return ['DOT', 'Like COMMA, switching dot for comma'];
            case self::FORMAT_TYPE_CCA:
                return ['CCA', 'User-programmable currency format (1)'];
            case self::FORMAT_TYPE_CCB:
                return ['CCB', 'User-programmable currency format (2)'];
            case self::FORMAT_TYPE_CCC:
                return ['CCC', 'User-programmable currency format (3)'];
            case self::FORMAT_TYPE_CCD:
                return ['CCD', 'User-programmable currency format (4)'];
            case self::FORMAT_TYPE_CCE:
                return ['CCE', 'User-programmable currency format (5)'];
            case self::FORMAT_TYPE_EDATE:
                return ['EDATE', 'Date in dd.mm.yyyy style'];
            case self::FORMAT_TYPE_SDATE:
                return ['SDATE', 'Date in yyyy/mm/dd style'];
        }

        return [null, null];
    }

    /**
     * @param int $alignment
     * @return string
     */
    public static function alignmentToString($alignment)
    {
        switch ($alignment) {
            case self::ALIGN_LEFT:
                return 'Left';
            case self::ALIGN_RIGHT:
                return 'Right';
            case self::ALIGN_CENTER:
                return 'Center';
        }

        return 'Invalid';
    }

    /**
     * @return int
     */
    public function getMeasure()
    {
        if ($this->measure !== null) {
            return $this->measure;
        }

        return $this->width == 0 ? self::MEASURE_UNKNOWN : self::MEASURE_NOMINAL;
    }

    /**
     * @return int
     */
    public function getAlignment()
    {
        if ($this->alignment !== null) {
            return $this->alignment;
        }

        return $this->width == 0 ? self::ALIGN_RIGHT : self::ALIGN_LEFT;
    }

    /**
     * @return int
     */
    public function getColumns()
    {
        if ($this->columns !== null) {
            return $this->columns;
        }

        return 8;
    }
}