Type.php

<?php
namespace Concrete\Core\Page\Type\PublishTarget\Type;

use Loader;
use Concrete\Core\Page\Type\Type as PageType;
use Concrete\Core\Foundation\ConcreteObject;
use Concrete\Core\Package\PackageList;
use Environment;
use Concrete\Core\Package\Package as Package;
use Core;
use Database;
use Symfony\Component\HttpFoundation\Request;

abstract class Type extends ConcreteObject
{
    protected $ptPublishTargetTypeID;
    protected $ptPublishTargetTypeHandle;
    protected $ptPublishTargetTypeName;
    protected $pkgID;

    abstract public function configurePageTypePublishTarget(PageType $pt, $post);

    abstract public function configurePageTypePublishTargetFromImport($txml);

    public function getPageTypePublishTargetTypeName()
    {
        return $this->ptPublishTargetTypeName;
    }

    public function getPageTypePublishTargetTypeHandle()
    {
        return $this->ptPublishTargetTypeHandle;
    }

    public function getPageTypePublishTargetTypeID()
    {
        return $this->ptPublishTargetTypeID;
    }

    public function getPackageID()
    {
        return $this->pkgID;
    }

    public function getPackageHandle()
    {
        return PackageList::getHandle($this->pkgID);
    }

    public function getPackageObject()
    {
        return Package::getByID($this->pkgID);
    }

    /** Returns the display name for this instance (localized and escaped accordingly to $format)
     * @param string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.
     *
     * @return string
     */
    public function getPageTypePublishTargetTypeDisplayName($format = 'html')
    {
        $value = tc('PageTypePublishTargetTypeName', $this->ptPublishTargetTypeName);
        switch ($format) {
            case 'html':
                return h($value);
            case 'text':
            default:
                return $value;
        }
    }

    public function validatePageTypeRequest(Request $request)
    {
        $e = Core::make('error');

        return $e;
    }

    public static function getByID($ptPublishTargetTypeID)
    {
        $db = Database::connection();
        $r = $db->fetchAssoc(
            'select ptPublishTargetTypeID, ptPublishTargetTypeHandle, ptPublishTargetTypeName, pkgID
                from PageTypePublishTargetTypes
                where ptPublishTargetTypeID = ?',
            array($ptPublishTargetTypeID)
        );
        if (is_array($r) && $r['ptPublishTargetTypeHandle']) {
            $txt = Loader::helper('text');
            $class = overrideable_core_class(
                'Core\\Page\\Type\\PublishTarget\\Type\\'
                . $txt->camelcase($r['ptPublishTargetTypeHandle']) . 'Type',
                DIRNAME_CLASSES . '/Page/Type/PublishTarget/Type/'
                . $txt->camelcase($r['ptPublishTargetTypeHandle']) . '.php',
                PackageList::getHandle($r['pkgID'])
            );

            $sc = Core::make($class);
            $sc->setPropertiesFromArray($r);

            return $sc;
        }

        return null;
    }

    public static function getByHandle($ptPublishTargetTypeHandle)
    {
        $db = Database::Connection();
        $r = $db->fetchAssoc(
            'select ptPublishTargetTypeID, ptPublishTargetTypeHandle, ptPublishTargetTypeName, pkgID
                from PageTypePublishTargetTypes
                where ptPublishTargetTypeHandle = ?',
            array($ptPublishTargetTypeHandle)
        );
        if (is_array($r) && isset($r['ptPublishTargetTypeHandle'])) {
            $txt = Loader::helper('text');
            $class = overrideable_core_class(
                'Core\\Page\\Type\\PublishTarget\\Type\\'
                . $txt->camelcase($r['ptPublishTargetTypeHandle']) . 'Type',
                DIRNAME_CLASSES . '/Page/Type/PublishTarget/Type/'
                . $txt->camelcase($r['ptPublishTargetTypeHandle']) . '.php',
                PackageList::getHandle($r['pkgID'])
            );

            $sc = Core::make($class);
            $sc->setPropertiesFromArray($r);

            return $sc;
        }

        return null;
    }

    public static function importConfiguredPageTypePublishTarget($txml)
    {
        $type = static::getByHandle((string) $txml['handle']);
        $target = $type->configurePageTypePublishTargetFromImport($txml);

        return $target;
    }

    public static function add($ptPublishTargetTypeHandle, $ptPublishTargetTypeName, $pkg = false)
    {
        $pkgID = 0;
        if (is_object($pkg)) {
            $pkgID = $pkg->getPackageID();
        }
        $db = Database::connection();
        $db->executeQuery(
            'insert into PageTypePublishTargetTypes (ptPublishTargetTypeHandle, ptPublishTargetTypeName, pkgID)
            values (?, ?, ?)',
            array($ptPublishTargetTypeHandle, $ptPublishTargetTypeName, $pkgID)
        );

        return static::getByHandle($ptPublishTargetTypeHandle);
    }

    public function delete()
    {
        $db = Database::connection();
        $db->executeQuery(
            'delete from PageTypePublishTargetTypes where ptPublishTargetTypeID = ?',
            array($this->ptPublishTargetTypeID)
        );
    }

    public static function getList()
    {
        $db = Database::connection();
        $ids = $db->fetchAll('select ptPublishTargetTypeID from PageTypePublishTargetTypes');
        $types = array();
        foreach ($ids as $id) {
            $type = static::getByID($id['ptPublishTargetTypeID']);
            if (is_object($type)) {
                $types[] = $type;
            }
        }
        usort(
            $types,
            function (Type $a, Type $b) {
                return strcasecmp(
                    $a->getPageTypePublishTargetTypeDisplayName(),
                    $b->getPageTypePublishTargetTypeDisplayName()
                );
            }
        );

        return $types;
    }

    public static function getListByPackage($pkg)
    {
        $db = Database::connection();
        $ids = $db->fetchAll(
            'select ptPublishTargetTypeID from PageTypePublishTargetTypes where pkgID = ?',
            array($pkg->getPackageID())
        );
        $types = array();
        foreach ($ids as $id) {
            $type = static::getByID($id['ptPublishTargetTypeID']);
            if (is_object($type)) {
                $types[] = $type;
            }
        }
        usort(
            $types,
            function (Type $a, Type $b) {
                return strcasecmp(
                    $a->getPageTypePublishTargetTypeDisplayName(),
                    $b->getPageTypePublishTargetTypeDisplayName()
                );
            }
        );

        return $types;
    }

    public function export($xml)
    {
        $type = $xml->addChild('type');
        $type->addAttribute('handle', $this->getPageTypePublishTargetTypeHandle());
        $type->addAttribute('name', $this->getPageTypePublishTargetTypeName());
        $type->addAttribute('package', $this->getPackageHandle());
    }

    public static function exportList($xml)
    {
        $list = self::getList();
        $nxml = $xml->addChild('pagetypepublishtargettypes');

        foreach ($list as $sc) {
            $sc->export($nxml);
        }
    }

    public function hasOptionsForm()
    {
        $env = Environment::get();
        $rec = $env->getRecord(
            DIRNAME_ELEMENTS . '/' . DIRNAME_PAGE_TYPES . '/' . DIRNAME_ELEMENTS_PAGE_TYPES_PUBLISH_TARGET_TYPES . '/' . $this->getPageTypePublishTargetTypeHandle(
            ) . '.php',
            $this->getPackageHandle()
        );

        return $rec->exists();
    }

    public function includeOptionsForm($pagetype = false, $siteType = false)
    {
        if (is_object($pagetype)) {
            $siteType = $pagetype->getSiteTypeObject();
        }
        Loader::element(
            DIRNAME_PAGE_TYPES . '/' . DIRNAME_ELEMENTS_PAGE_TYPES_PUBLISH_TARGET_TYPES . '/' . $this->getPageTypePublishTargetTypeHandle(
            ),
            array('type' => $this, 'pagetype' => $pagetype, 'sitetype' => $siteType),
            $this->getPackageHandle()
        );
    }
}