Overview

Namespaces

  • SpanishGuestReportGenerator
    • Util

Classes

  • SpanishGuestReportGenerator\AbstractFactory
  • SpanishGuestReportGenerator\Guest
  • SpanishGuestReportGenerator\GuestFactory
  • SpanishGuestReportGenerator\GuestReport
  • SpanishGuestReportGenerator\Hotel
  • SpanishGuestReportGenerator\HotelFactory
  • SpanishGuestReportGenerator\Util\Helper

Traits

  • SpanishGuestReportGenerator\FormatterTrait
  • SpanishGuestReportGenerator\SanitizerTrait

Exceptions

  • SpanishGuestReportGenerator\FactoryException
  • SpanishGuestReportGenerator\GuestReportException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 
<?php
/**
 * Spanish Guest Report Generator
 *
 * @package    Spanish Guest Report Generator
 * @author     Javier Zapata <javierzapata82@gmail.com>
 * @copyright  2021 Javier Zapata <javierzapata82@gmail.com>
 * @license    https://opensource.org/licenses/MIT  The MIT License
 * @link       https://github.com/bahiazul/spanish-guest-report-generator
 */

namespace SpanishGuestReportGenerator;

/**
 * Guest
 *
 * @package    Spanish Guest Report Generator
 * @author     Javier Zapata <javierzapata82@gmail.com>
 * @copyright  2021 Javier Zapata <javierzapata82@gmail.com>
 * @license    https://opensource.org/licenses/MIT  The MIT License
 * @link       https://github.com/bahiazul/spanish-guest-report-generator
 */
class Guest
{
    use FormatterTrait;
    use SanitizerTrait;

    /**
     * First digit for the Guest info line
     *
     * @var integer
     */
    const ROW_TYPE = 2;

    /**
     * Is Spanish citizen?
     *
     * @var boolean
     */
    private $isSpanish;

    /**
     * Identification number
     *
     * @var string
     */
    private $idNumber = '';

    /**
     * Type of ID
     *
     * @var string
     */
    private $docType = '';

    /**
     * Issue date of the ID
     *
     * @var string
     */
    private $docIssueDate = '';

    /**
     * Last name
     *
     * @var string
     */
    private $lastName1 = '';

    /**
     * Second last name (only required for Spanish citizens)
     *
     * @var string
     */
    private $lastName2 = '';

    /**
     * First name
     *
     * @var string
     */
    private $firstName = '';

    /**
     * Gender
     *
     * @var string
     */
    private $gender = '';

    /**
     * Birth date
     *
     * @var string
     */
    private $birthDate = '';

    /**
     * Country of nationality
     *
     * @var string
     */
    private $countryName = '';

    /**
     * Arrival date
     *
     * @var string
     */
    private $arrivalDate = '';

    /**
     * Create a new Guest
     *
     * @param boolean $isSpanish    Indicates if the guest is a spanish resident
     * @param string  $idNumber     ID number that appears in the document
     * @param string  $docType      Letter identifying the type
     * @param string  $docIssueDate Expiration date of the document
     * @param string  $lastName1    First last name
     * @param string  $lastName2    Second last name (only required for spaniards)
     * @param string  $firstName    First name
     * @param string  $gender       Letter identifying the gender
     * @param string  $birthDate    Date of birth
     * @param string  $countryName  Name of the country
     * @param string  $arrivalDate  Date of arrival
     */
    public function __construct(
        $isSpanish    = false,
        $idNumber     = '',
        $docType      = '',
        $docIssueDate = '',
        $lastName1    = '',
        $lastName2    = '',
        $firstName    = '',
        $gender       = '',
        $birthDate    = '',
        $countryName  = '',
        $arrivalDate  = ''
    ) {
        $this->setIsSpanish($isSpanish);
        $this->setIDNumber($idNumber);
        $this->setDocType($docType);
        $this->setDocIssueDate($docIssueDate);
        $this->setLastName1($lastName1);
        $this->setLastName2($lastName2);
        $this->setFirstName($firstName);
        $this->setGender($gender);
        $this->setBirthDate($birthDate);
        $this->setCountryName($countryName);
        $this->setArrivalDate($arrivalDate);
    }

    /**
     * Sets wether or not the guest is a Spanish citizen
     *
     * @param   boolean $isSpanish
     * @return  Guest
     */
    public function setIsSpanish($isSpanish)
    {
        $this->isSpanish = (bool) $isSpanish;

        return $this;
    }

    /**
     * Sets the ID number
     *
     * @param   string  $idNumber  ID Number
     * @return  Guest
     */
    public function setIDNumber($idNumber)
    {
        $this->idNumber = $this->isSpanish
                        ? $this->sanitizeSpanishID($idNumber)
                        : $this->sanitizeForeignID($idNumber);

        return $this;
    }

    /**
     * Sets the document type
     *
     * @param   string $docType Letter identifying the type
     * @return  Guest
     */
    public function setDocType($docType)
    {
        $this->docType = $this->sanitizeDocType($docType);

        return $this;
    }

    /**
     * Sets the document issue date
     *
     * @param   string $date The date
     * @return  Guest
     */
    public function setDocIssueDate($date)
    {
        $this->docIssueDate = $this->sanitizeDate($date);

        return $this;
    }

    /**
     * Sets the first last name
     *
     * @param   string $lastName1 First last name
     * @return  Guest
     */
    public function setLastName1($lastName1)
    {
        $this->lastName1 = $this->sanitizePersonName($lastName1);

        return $this;
    }

    /**
     * Sets the second last name (only required for spanish citizens)
     *
     * @param   string $lastName2 Second last name
     * @return  Guest
     */
    public function setLastName2($lastName2)
    {
        $this->lastName2 = $this->sanitizePersonName($lastName2);

        return $this;
    }

    /**
     * Sets the first name
     *
     * @param   string $firstName First name
     * @return  Guest
     */
    public function setFirstName($firstName)
    {
        $this->firstName = $this->sanitizePersonName($firstName);

        return $this;
    }

    /**
     * Sets the gender
     *
     * @param   string $gender Letter identifying the gender
     * @return  Guest
     */
    public function setGender($gender)
    {
        $this->gender = $this->sanitizeGender($gender);

        return $this;
    }

    /**
     * Sets the birth date
     *
     * @param   string $date Birth date
     * @return  Guest
     */
    public function setBirthDate($date)
    {
        $this->birthDate = $this->sanitizeDate($date);

        return $this;
    }

    /**
     * Sets the country name
     *
     * @param   string $countryName Country name
     * @return  Guest
     */
    public function setCountryName($countryName)
    {
        $this->countryName = $this->sanitizeCountryName($countryName);

        return $this;
    }

    /**
     * Sets the arrival date
     *
     * @param   string $date Arrival date
     * @return  Guest
     */
    public function setArrivalDate($date)
    {
        $this->arrivalDate = $this->sanitizeDate($date);

        return $this;
    }

    /**
     * Returns the data for this object
     *
     * @return array
     */
    public function getCols()
    {
        $cols = [];
        $cols[] = self::ROW_TYPE;
        $cols[] = $this->isSpanish ? $this->idNumber : '';
        $cols[] = $this->isSpanish ? '' : $this->idNumber;
        $cols[] = $this->docType;
        $cols[] = $this->docIssueDate;
        $cols[] = $this->lastName1;
        $cols[] = $this->lastName2;
        $cols[] = $this->firstName;
        $cols[] = $this->gender;
        $cols[] = $this->birthDate;
        $cols[] = $this->countryName;
        $cols[] = $this->arrivalDate;

        return $cols;
    }
}
API documentation generated by ApiGen