silverstripe / silverstripe-sharedraftcontent

src/Extensions/ShareDraftContentSiteTreeExtension.php

<?php

namespace SilverStripe\ShareDraftContent\Extensions;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\HasManyList;
use SilverStripe\Security\RandomGenerator;
use SilverStripe\ShareDraftContent\Models\ShareToken;

/**
 * @property SiteTree|ShareDraftContentSiteTreeExtension $owner
 * @property string $ShareTokenSalt
 * @method HasManyList|ShareToken[] ShareTokens()
 */
class ShareDraftContentSiteTreeExtension extends DataExtension
{
    /**
     * The number of days a shared link should be valid for, before expiring.
     *
     * @config
     *
     * @var int
     */
    private static $valid_for_days = 30;

The private property $valid_for_days is not used, and could be removed.

    /**
     * @var array
     */
    private static $db = array(

The private property $db is not used, and could be removed.

        'ShareTokenSalt' => 'Varchar(16)',
    );

    /**
     * @var array
     */
    private static $has_many = array(

The private property $has_many is not used, and could be removed.

        'ShareTokens' => ShareToken::class,
    );

    /**
     * @var array
     */
    private static $allowed_actions = array(

The private property $allowed_actions is not used, and could be removed.

        'MakeShareDraftLink'
    );

    /**
     * @return string
     */
    public function ShareTokenLink()
    {
        $shareToken = $this->getNewShareToken();

        return Controller::join_links(
            Director::absoluteBaseURL(),
            'preview',
            $this->generateKey($shareToken->Token),
            $shareToken->Token
        );
    }

    /**
     * @return ShareToken
     */
    protected function getNewShareToken()
    {
        if (!$this->owner->ShareTokenSalt) {
            $this->owner->ShareTokenSalt = $this->getNewToken();
            $this->owner->writeWithoutVersion();

The method writeWithoutVersion() does not exist on SilverStripe\ShareDraftContent\Extensions\ShareDraftContentSiteTreeExtension.

        }

        $found = null;
        $token = null;
        $tries = 1;
        $limit = 5;

        while (!$found && ($tries++ < $limit)) {
            $token = $this->getNewToken();

            $found = ShareToken::get()->filter(array(
                "Token" => $token,
                "PageID" => $this->owner->ID,

The property ID does not exist on SilverStripe\ShareDraftContent\Extensions\ShareDraftContentSiteTreeExtension. Did you maybe forget to declare it?

            ))->first();
        }

        $config = Config::forClass(__CLASS__);

        $validForDays = $config->get('valid_for_days');

        $token = ShareToken::create(array(
            "Token" => $token,
            "ValidForDays" => $validForDays,
            "PageID" => $this->owner->ID,
        ));

        $token->write();

        return $token;

The expression return $token also could return the type string which is incompatible with the documented return type SilverStripe\ShareDraftContent\Models\ShareToken.

    }

    /**
     * @return string
     */
    protected function getNewToken()
    {
        $generator = new RandomGenerator();

        return substr($generator->randomToken('sha256'), 0, 16);
    }

    /**
     * @param string $salt
     *
     * @return string
     */
    public function generateKey($salt)
    {
        return hash_pbkdf2('sha256', $salt, $this->owner->ShareTokenSalt, 1000, 16);
    }

    /**
     * @return string
     */
    public function getShareDraftLinkAction()
    {
        return $this->owner->Link('MakeShareDraftLink');

The method Link() does not exist on SilverStripe\ShareDraftContent\Extensions\ShareDraftContentSiteTreeExtension.

    }
}