Phraseanet/lib/Alchemy/Phrasea/Model/Serializer/CaptionSerializer.php

<?php
/*
 * This file is part of Phraseanet
 *
 * (c) 2005-2016 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Phrasea\Model\Serializer;

use Alchemy\Phrasea\Media\TechnicalDataService;
use Symfony\Component\Yaml\Dumper as YamlDumper;

class CaptionSerializer extends AbstractSerializer
{
    const SERIALIZE_XML = 'xml';
    const SERIALIZE_YAML = 'yaml';
    const SERIALIZE_JSON = 'json';

    /**
     * @var TechnicalDataService|callable
     */
    private $technicalDataService;

    /**
     * @param callable|TechnicalDataService $technicalDataService
     * @throws \InvalidArgumentException
     */
    public function __construct($technicalDataService)
    {
        if (!$technicalDataService instanceof TechnicalDataService && !is_callable($technicalDataService)) {
            throw new \InvalidArgumentException(sprintf(
                'Expects a callable or %s, got %s',
                TechnicalDataService::class,
                is_object($technicalDataService) ? get_class($technicalDataService) : gettype($technicalDataService)
            ));
        }

        $this->technicalDataService = $technicalDataService;
    }

    /**
     * @param \caption_record $caption
     * @param string $format
     * @param bool $includeBusinessFields
     * @return string
     * @throws \Exception
     */
    public function serialize(\caption_record $caption, $format, $includeBusinessFields = false)
    {
        switch ($format) {
            case self::SERIALIZE_XML:
                return $this->serializeXML($caption, (bool) $includeBusinessFields);
            case self::SERIALIZE_YAML:
                return $this->serializeYAML($caption, (bool) $includeBusinessFields);
            case self::SERIALIZE_JSON:
                return $this->serializeJSON($caption, (bool) $includeBusinessFields);
            default:
                throw new \Exception(sprintf('Unknown format %s', $format));
        }
    }

    private function serializeYAML(\caption_record $caption, $includeBusinessFields)
    {
        return (new YamlDumper())->dump($this->toArray($caption, $includeBusinessFields), 3);
    }

    private function serializeJSON(\caption_record $caption, $includeBusinessFields)
    {
        return \p4string::jsonencode($this->toArray($caption, $includeBusinessFields));
    }

    /**
     * @param \caption_record $caption
     * @param bool $includeBusinessFields
     * @return array
     */
    public function toArray(\caption_record $caption, $includeBusinessFields)
    {
        $buffer = [];

        foreach ($caption->get_fields([], $includeBusinessFields) as $field) {
            $vi = $field->get_values();

            if ($field->is_multi()) {
                $buffer[$field->get_name()] = [];
                foreach ($vi as $value) {
                    $val = $value->getValue();
                    $buffer[$field->get_name()][] = ctype_digit($val) ? (int) $val : $this->sanitizeSerializedValue($val);
                }
            } else {
                $value = array_pop($vi);
                $val = $value->getValue();
                $buffer[$field->get_name()] = ctype_digit($val) ? (int) $val : $this->sanitizeSerializedValue($val);
            }
        }

        return ['record' => ['description' => $buffer]];
    }

    private function serializeXML(\caption_record $caption, $includeBusinessFields)
    {
        $dom_doc = new \DOMDocument('1.0', 'UTF-8');
        $dom_doc->formatOutput = true;
        $dom_doc->standalone = true;

        $record = $dom_doc->createElement('record');
        $record->setAttribute('record_id', $caption->getRecordReference()->getRecordId());
        $dom_doc->appendChild($record);
        $description = $dom_doc->createElement('description');
        $record->appendChild($description);

        foreach ($caption->get_fields([], $includeBusinessFields) as $field) {
            $values = $field->get_values();

            foreach ($values as $value) {
                $elem = $dom_doc->createElement($field->get_name());
                $elem->appendChild($dom_doc->createTextNode($this->sanitizeSerializedValue($value->getValue())));
                $elem->setAttribute('meta_id', $value->getId());
                $elem->setAttribute('meta_struct_id', $field->get_meta_struct_id());
                $description->appendChild($elem);
            }
        }

        $doc = $dom_doc->createElement('doc');

        $technicalData = $this->getTechnicalDataService()->fetchRecordsTechnicalData([$caption->getRecordReference()]);
        $tc_datas = $technicalData[0]->getValues();

        foreach ($tc_datas as $key => $data) {
            $doc->setAttribute($key, $data);
        }

        $record->appendChild($doc);

        return $dom_doc->saveXML();
    }

    /**
     * @return TechnicalDataService
     * @throws \UnexpectedValueException
     */
    private function getTechnicalDataService()
    {
        if (!$this->technicalDataService instanceof TechnicalDataService) {
            $instance = call_user_func($this->technicalDataService);

            if (!$instance instanceof TechnicalDataService) {
                throw new \UnexpectedValueException(sprintf(
                    'Expected a %s instance, got %s.',
                    TechnicalDataService::class,
                    is_object($instance) ? get_class($instance) : gettype($instance)
                ));
            }

            $this->technicalDataService = $instance;
        }

        return $this->technicalDataService;
    }
}