Header::read() - Code Metrics - collecthor/spss - Measure and Improve Code Quality continuously with Scrutinizer

Header::read() A
last analyzed 2020-11-12 11:01 UTC

↳ Parent: Header
Complexity

Conditions	5
Paths	3
Size

Total Lines	29
Code Lines	18
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	30
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	5
eloc	18
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	29
ccs	0
cts	22
cp	0
crap	30
rs	9.3554
<?php

namespace SPSS\Sav\Record;

use SPSS\Buffer;
use SPSS\Exception;
use SPSS\Sav\Record;

class Header extends Record
{
    const NORMAL_REC_TYPE = '$FL2';
    const ZLIB_REC_TYPE = '$FL3';

    /**
     * @var string Record type code,
     * either ‘$FL2’ for system files with uncompressed data or data compressed with simple bytecode compression,
     * or ‘$FL3’ for system files with ZLIB compressed data.
     * This is truly a character field that uses the character encoding as other strings.
     * Thus, in a file with an ASCII-based character encoding this field contains 24 46 4c 32 or 24 46 4c 33,
     * and in a file with an EBCDIC-based encoding this field contains 5b c6 d3 f2.
     * (No EBCDIC-based ZLIB-compressed files have been observed.)
     */
    public $recType = self::NORMAL_REC_TYPE;

    /**
     * @var string Product identification string.
     * This always begins with the characters ‘@(#) SPSS DATA FILE’.
     * The string is truncated if it would be longer than 60 characters;
     * otherwise it is padded on the right with spaces.
     */
    public $prodName = '@(#) SPSS DATA FILE';

    /**
     * @var int Normally set to 2, although a few system files have been spotted in the wild with a value of 3 here.
     */
    public $layoutCode = 2;

    /**
     * @var int Number of data elements per case.
     * This is the number of variables, except that long string variables add extra data elements (one for every 8 characters after the first 8).
     * Further, system files written by some systems set this value to -1.
     * In general, it is unsafe for systems reading system files to rely upon this value.
     */
    public $nominalCaseSize = 0;

    /**
     * @var int
     * Set to
     * 0 if the data in the file is not compressed,
     * 1 if the data is compressed with simple bytecode compression,
     * 2 if the data is ZLIB compressed.
     * This field has value 2 if and only if recType is ‘$FL3’.
     */
    public $compression = 1;

    /**
     * @var int If one of the variables in the data set is used as a weighting variable,
     * set to the dictionary index of that variable, plus 1 (see Dictionary Index).
     * Otherwise, set to 0.
     */
    public $weightIndex = 0;

    /**
     * @var int Set to the number of cases in the file if it is known, or -1 otherwise.
     * In the general case it is not possible to determine the number of cases that will be output to a system file at the time
     * that the header is written.
     * The way that this is dealt with is by writing the entire system file,
     * including the header, then seeking back to the beginning of the file and writing just the ncases field.
     * For files in which this is not valid, the seek operation fails.
     * In this case, ncases remains -1.
     */
    public $casesCount = -1;

    /**
     * @var int Compression bias, ordinarily set to 100.
     * Only integers between 1 - bias and 251 - bias can be compressed.
     * By assuming that its value is 100.
     */
    public $bias = 100;

    /**
     * @var string Date of creation of the system file, in ‘dd mmm yy’ format,
     * with the month as standard English abbreviations, using an initial capital letter and following with lowercase.
     * If the date is not available then this field is arbitrarily set to ‘01 Jan 70’.
     */
    public $creationDate = '01 Jan 70';

    /**
     * @var string Time of creation of the system file, in ‘hh:mm:ss’ format and using 24-hour time.
     * If the time is not available then this field is arbitrarily set to ‘00:00:00’.
     */
    public $creationTime = '00:00:00';

    /**
     * @var string File label declared by the user (64 chars).
     * Padded on the right with spaces.
     */
    public $fileLabel;

    /**
     * @param Buffer $buffer
     * @throws Exception
     */
    public function read(Buffer $buffer)
    {
        $this->recType = $buffer->readString(4);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        if (! ($this->recType == self::NORMAL_REC_TYPE || $this->recType == self::ZLIB_REC_TYPE)) {
            throw new Exception('Read header error: this is not a valid SPSS file. Does not start with $FL2 or $FL3.');
        }
        $this->prodName = trim($buffer->readString(60));
        $this->prodName = trim(/** @scrutinizer ignore-type */ $buffer->readString(60));
        $this->layoutCode = $buffer->readInt();

        // layoutCode should be 2 or 3.
        // If not swap bytes and check again which would then indicate big-endian
        if ($this->layoutCode != 2 && $this->layoutCode != 3) {
            // try to flip to big-endian mode and read again
            $buffer->isBigEndian = true;
            $buffer->skip(-4);
            $this->layoutCode = $buffer->readInt();
        }

        $this->nominalCaseSize = $buffer->readInt();
        $this->compression = $buffer->readInt();
        $this->weightIndex = $buffer->readInt();
        $this->casesCount = $buffer->readInt();
        $this->bias = $buffer->readDouble();
        $this->creationDate = $buffer->readString(9);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->creationTime = $buffer->readString(8);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->fileLabel = trim($buffer->readString(64));

        // 3-byte padding to make the header a multiple of 32 bits in length.
        $buffer->skip(3);
    }

    /**
     * @param Buffer $buffer
     */
    public function write(Buffer $buffer)
    {
        $buffer->write($this->recType);
        $buffer->writeString($this->prodName, 60);
        $buffer->writeInt($this->layoutCode);
        $buffer->writeInt($this->nominalCaseSize);
        $buffer->writeInt($this->compression);
        $buffer->writeInt($this->weightIndex);
        $buffer->writeInt($this->casesCount);
        $buffer->writeDouble($this->bias);
        $buffer->writeString($this->creationDate, 9);
        $buffer->writeString($this->creationTime, 8);
        $buffer->writeString($this->fileLabel, 64);
        $buffer->writeNull(3);
    }
}

collecthor / spss

Header::read() A last analyzed 2020-11-12 11:01 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Header::read() A
last analyzed 2020-11-12 11:01 UTC
