sunnysideup / silverstripe-cms-niceties

src/Traits/CMSNicetiesTraitForCMSLinks.php

<?php

namespace Sunnysideup\CMSNiceties\Traits;

use SilverStripe\Admin\ModelAdmin;
// use SilverStripe\Forms\GridField\GridFieldArchiveAction;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\HTMLReadonlyField;
use Sunnysideup\CmsEditLinkField\Api\CMSEditLinkAPI;

The type Sunnysideup\CmsEditLinkField\Api\CMSEditLinkAPI was not found. Maybe you did not declare it correctly or list all dependencies?

trait CMSNicetiesTraitForCMSLinks
{
    public function CMSEditLink()
    {
        if ($this instanceof SiteTree) {
            return parent::CMSEditLink();
        }
        return CMSEditLinkAPI::find_edit_link_for_object($this);
    }

    public function CMSEditLinkLimited(): string
    {
        return CMSEditLinkAPI::find_edit_link_for_object($this);
    }

    public function CMSEditLinkField(string $relName, string $name = ''): HTMLReadonlyField
    {
        $obj = $this->{$relName}();
        if ($name === '' || $name === '0') {
            $nameOptions = $this->fieldLabels();

It seems like fieldLabels() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $name = $nameOptions[$relName] ?? $nameOptions[$relName . 'ID'] ?? 'error';
        }

        if ($obj && $obj->exists()) {
            $value = '<a href="' . $obj->CMSEditLink() . '">' . $obj->getTitle() . '</a>';
        } else {
            $value = '<em>(none)</em>';
        }

        return HTMLReadonlyField::create(
            $relName . 'Link',
            $name,
            $value
        );
    }

    public function CMSAddLink(): string
    {
        return CMSEditLinkAPI::find_add_link_for_object($this->ClassName);
    }

    public function CMSListLink(): string
    {
        $controller = $this->myModelAdminController();
        if ($controller) {
            return $controller->getLinkForModelClass($this->ClassName);
        }

        return '404-cms-list-link-not-found';
    }

    /**
     * @return null|ModelAdmin
     */
    protected function myModelAdminController()
    {
        $modelAdminClassName = $this->Config()->get('primary_model_admin_class');

It seems like Config() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $obj = null;
        if ($modelAdminClassName) {
            /** @var null|ModelAdmin $obj */
            $obj = Injector::inst()->get($modelAdminClassName);
        }

        return $obj;
    }

    /**
     * Sanitise a model class' name for inclusion in a link.
     */
    protected function sanitisedClassName(): string
    {
        $className = (string) $this->hasMethod('classNameForModelAdmin') !== '' && (string) $this->hasMethod('classNameForModelAdmin') !== '0' ? $this->classNameForModelAdmin() : $this->ClassName;

It seems like classNameForModelAdmin() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like hasMethod() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return str_replace('\\', '-', $className);
    }
}