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: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 

<?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;

use SpanishGuestReportGenerator\Util\Helper;

/**
 * Guest Report
 *
 * @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 GuestReport
{
    use FormatterTrait;
    use SanitizerTrait;

    /**
     * Newline character to use
     *
     * @var string
     */
    const FILE_NEWLINE  = "\r\n";

    /**
     * Character encoding to use
     *
     * @var string
     */
    const FILE_ENCODING = 'CP437';

    /**
     * Path to the directory in which to save the generated file
     *
     * @var string
     */
    private $directoryPath;

    /**
     * Delimiter for all the fields in the document
     *
     * @var string
     */
    const FIELD_DELIMITER = '|';

    /**
     * First digit for the Chain info line
     *
     * @var integer
     */
    const ROW_TYPE = 0;

    /**
     * Sequential number of the document to generate (1-999)
     *
     * @var string
     */
    private $reportNumber = '999';

    /**
     * Unique code (given by the authorities) for the Hotel Chain
     *
     * @var string
     */
    private $chainCode = '';

    /**
     * Name of the Hotel Chain (max. 40 characters)
     *
     * @var string
     */
    private $chainName = '';

    /**
     * Date and time of the report
     *
     * @var \DateTime
     */
    private $reportDateTime;

    /**
     * Holds all the Hotels
     *
     * @var array
     */
    private $hotels = [];

    /**
     * Hotel creator class
     *
     * @var HotelFactory
     */
    private $hotelFactory;

    /**
     * Guest creator class
     *
     * @var GuestFactory
     */
    private $guestFactory;

    /**
     * Creates a new report
     *
     * @param   HotelFactory $hotelFactory    Hotel creator class
     * @param   GuestFactory $guestFactory    Guest creator class
     * @param   \DateTime    $reportDateTime  Date and time of the report
     */
    public function __construct(
        HotelFactory $hotelFactory,
        GuestFactory $guestFactory,
        \DateTime $reportDateTime = null
    ) {
        $this->hotelFactory = $hotelFactory;
        $this->guestFactory = $guestFactory;

        $this->setReportDateTime($reportDateTime ?: new \DateTime);
    }

    /**
     * Sets the Chain's code
     *
     * @param   string $chainCode
     * @return  GuestReport
     */
    public function setChainCode($chainCode)
    {
        $this->chainCode = $this->sanitizeCode($chainCode);

        return $this;
    }

    /**
     * Sets the Chain's name
     *
     * @param   string $chainName Chain name
     * @return  GuestReport
     */
    public function setChainName($chainName)
    {
        $this->chainName = $this->sanitizeBizName($chainName);

        return $this;
    }

    /**
     * Sets the report number
     *
     * @param   mixed $reportNumber Report number
     * @return  GuestReport
     */
    public function setReportNumber($reportNumber)
    {
        // Clean any nasty input
        $reportNumber = Helper::stringify($reportNumber);

        // Get rid of floats
        $reportNumber = intval($reportNumber);

        // Reset any out of range numbers
        if ($reportNumber < 1 || $reportNumber > 999) {
            $reportNumber = 1;
        }

        // Convert back to string
        $reportNumber = strval($reportNumber);

        $this->reportNumber = str_pad($reportNumber, 3, '0', STR_PAD_LEFT);

        return $this;
    }

    /**
     * Sets the Date and time of the report
     *
     * @param   \DateTime $reportDateTime Date and time of the report
     * @return  GuestReport
     */
    public function setReportDateTime(\DateTime $reportDateTime)
    {
        $this->reportDateTime = $reportDateTime;

        return $this;
    }

    /**
     * Sets the info and contents for the Chain
     *
     * @param   string    $chainCode      Code of the Chain
     * @param   string    $chainName      Name of the Chain
     * @param   \DateTime $reportDateTime Date and Time of report
     * @param   array     $hotels         Hotels that belong to this Chain
     * @return  GuestReport
     */
    public function setChain($chainCode, $chainName, \DateTime $reportDateTime, array $hotels = [])
    {
        $this->setChainCode($chainCode);
        $this->setChainName($chainName);
        $this->setReportDateTime($reportDateTime);
        $this->setHotels($hotels);

        return $this;
    }

    /**
     * Set multiple Hotels at once
     *
     * @param   array  $hotels    Hotels
     * @return  GuestReport
     */
    public function setHotels(array $hotels)
    {
        foreach ($hotels as $h) {
            $hotelCode      = '';
            $hotelName      = '';
            $reportDateTime = new \DateTime;
            $guests         = [];

            extract($h);

            $this->setHotel($hotelCode, $hotelName, $reportDateTime, $guests);
        }

        return $this;
    }

    /**
     * Sets the info and contents for a single Hotel
     *
     * @param   string    $hotelCode      Code of the Hotel
     * @param   string    $hotelName      Name of the Hotel
     * @param   \DateTime $reportDateTime Date and Time of report
     * @param   array     $guests         Guests that belong to this Hotel
     * @return  GuestReport
     */
    public function setHotel(
        $hotelCode,
        $hotelName,
        \DateTime $reportDateTime = null,
        array $guests = []
    ) {
        $hotelCode = $this->sanitizeCode($hotelCode);
        $guests = $this->guestFactory->buildMultiple($guests);

        $reportDateTime ?: new \DateTime;

        $args = compact('hotelCode', 'hotelName', 'reportDateTime', 'guests');
        $this->hotels[$hotelCode] = $this->hotelFactory->build($args);

        return $this;
    }

    /**
     * Set the Guests for a specific Hotel
     *
     * @param   string $hotelCode Code of the Hotel
     * @param   array  $guests    Guests that belong to this Hotel
     * @return  GuestReport
     * @throws  GuestReportException
     */
    public function setHotelGuests($hotelCode, array $guests)
    {
        if (!$hotel = &$this->hotels[$hotelCode]) {
            throw new GuestReportException("Hotel by code `{$hotelCode}` not found.");
        }

        $guests = $this->guestFactory->buildMultiple($guests);

        $hotel->setGuests($guests);

        return $this;
    }

    /**
     * Sets the path in which the generated file will be saved
     *
     * @param   string  $path   Destination path
     * @param   boolean $create Create the path if it does not exist
     * @return  GuestReport
     * @throws  GuestReportException
     */
    public function setDirectoryPath($path, $create = true)
    {
        $path = rtrim(Helper::stringify($path), '\/');

        if (!is_dir($path)) {
            if (!$create) {
                throw new GuestReportException("Path `{$path}` does not exist.");
            }

            if (!mkdir($path, 0775, true)) {
                throw new GuestReportException("Could not create directory `{$path}`.");
            }
        }

        if (!is_writable($path)) {
            if (!chmod($path, 0775)) {
                throw new GuestReportException("Could not make directory `{$path}` writable.");
            }
        }

        $this->directoryPath = $path;

        return $this;
    }

    /**
     * Returns the output filename
     *
     * @return string Output filename
     */
    public function getFilename()
    {
        switch (count($this->hotels)) {
            case 0:
                $filename = 'EMPTY';
                break;

            // The hotel code
            case 1:
                $hotels = $this->hotels;
                reset($hotels);
                $filename = key($hotels);
                break;

            default:
                $filename = $this->chainCode ?: 'NONAME';
                break;
        }

        return $filename.'.'.$this->reportNumber;
    }

    /**
     * Save the report to a file
     *
     * @param   boolean $overwrite  Overwrite the file if already exists
     * @return  boolean             Whether the file was succesfully saved
     * @throws  GuestReportException
     */
    public function save($overwrite = true)
    {
        $filename  = realpath($this->directoryPath); // Fallback to the current directory
        $filename .= '/'.$this->getFilename();

        if (file_exists($filename) && !$overwrite) {
            throw new GuestReportException("File `{$filename}` already exists.");
        }

        $data = $this->getContents();

        return (bool) file_put_contents($filename, $data);
    }

    /**
     * Returns the report's contents
     *
     * @return  string The report's contents
     */
    private function getContents()
    {
        $lines = array_map(function($cols){ return self::rowToLine($cols); }, $this->getRows());

        $contents = implode(self::FILE_NEWLINE, $lines);
        $contents = iconv(mb_internal_encoding(), self::FILE_ENCODING.'//TRANSLIT', $contents);

        return $contents;
    }

    /**
     * Returns the report's data
     *
     * @return array
     */
    private function getRows()
    {
        $rows = [];
        foreach ($this->hotels as $hotel) {
            $rows = array_merge($rows, $hotel->getRows());
        }

        if (count($this->hotels) > 1) {
            array_unshift($rows, $this->getHeadRow());
        }

        return $rows;
    }

    /**
     * Returns the data for the Chain info row
     *
     * @return array
     */
    private function getHeadRow()
    {
        $cols = [];
        $cols[] = self::ROW_TYPE;
        $cols[] = $this->chainCode;
        $cols[] = $this->chainName;
        $cols[] = $this->formatDate($this->reportDateTime);
        $cols[] = $this->formatTime($this->reportDateTime);
        $cols[] = count($this->hotels);

        return $cols;
    }

    /**
     * Generates a line of text from a given array of values
     *
     * @param  array  $cols      The data
     * @return string
     */
    private static function rowToLine(array $cols)
    {
        $row = mb_strtoupper(implode(self::FIELD_DELIMITER, $cols));

        return $row . self::FIELD_DELIMITER;
    }
}