Post::GhostLink() - Code Metrics - Inspection of "Test against 3, doc improvements and removed dupli..." - silverstripe/silverstripe-forum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#186)

by Daniel

created 2016-03-21 14:11 UTC

Post::GhostLink() A

↳ Parent: Post

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	6

Duplication

Lines	8
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	8
loc	8
rs	9.4285
cc	2
eloc	6
nc	2
nop	0

<?php

/**
 * Forum Post Object. Contains a single post by the user. A thread is generated 
 * with multiple posts.
 *
 * @package forum
 */

class Post extends DataObject {
	
	private static $db = array(

		"Content" => "Text",
		"Status" => "Enum('Awaiting, Moderated, Rejected, Archived', 'Moderated')",
	);

	private static $casting = array(

		"Updated" => "SS_Datetime",
		"RSSContent" => "HTMLText",
		"RSSAuthor" => "Varchar",
		"Content" => "HTMLText"
	);

	private static $has_one = array(

		"Author" => "Member",
		"Thread" => "ForumThread",
		"Forum" => "Forum" // denormalized data but used for read speed
	);

	private static $has_many = array(

		"Attachments" => "Post_Attachment"
	);
	
	private static $summary_fields = array(

		"Content.LimitWordCount" => "Summary",
		"Created" => "Created",
		"Status" => "Status",
		"Thread.Title" => "Thread",
		"Forum.Title" => "Forum"
	);

	/**
	 * Update all the posts to have a forum ID of their thread ID. 
	 */
	function requireDefaultRecords() {

		$posts = Post::get()->filter(array('ForumID' => 0, 'ThreadID:GreaterThan' => 0));

		if($posts->exists()) {
			foreach($posts as $post) {
				if($post->ThreadID) {
					$post->ForumID = $post->Thread()->ForumID;
					$post->write();
				}
			}
			
			DB::alteration_message(_t('Forum.POSTSFORUMIDUPDATED', 'Forum posts forum ID added'), 'created');
		}
	}
	
	/**
	 * Before deleting a post make sure all attachments are also deleted
	 */
	function onBeforeDelete() {

		parent::onBeforeDelete();
		
		if($attachments = $this->Attachments()) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			foreach($attachments as $file) {
				$file->delete();
				$file->destroy();
			}
		}	
	}

	/**
	 * Check if user can see the post
	 */
	function canView($member = null) {

		if(!$member) $member = Member::currentUser();
		
		if($this->Author()->ForumStatus != 'Normal') {

			if($this->AuthorID != $member->ID || $member->ForumStatus != 'Ghost') {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
				return false;
			}
		}

		return $this->Thread()->canView($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}

	/**
	 * Check if user can edit the post (only if it's his own, or he's an admin user)
	 */
	function canEdit($member = null) {

		if(!$member) $member = Member::currentUser();
		
		if($member) {
			// Admins can always edit, regardless of thread/post ownership
			if(Permission::checkMember($member, 'ADMIN')) return true;

			// Otherwise check for thread permissions and ownership
			if($this->Thread()->canPost($member) && $member->ID == $this->AuthorID) return true;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		} 

		return false;
	}
	
	/**
	 * Follow edit permissions for this, but additionally allow moderation even
	 * if the thread is marked as readonly.
	 */
	function canDelete($member = null) {

		if(!$member) $member = Member::currentUser();
		if($this->canEdit($member)) {
			return true;
		} else {
			return $this->Thread()->canModerate($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		}
	}
	
	/**
	 * Check if user can add new posts - hook up into canPost.
	 */
	function canCreate($member = null) {

		if(!$member) $member = Member::currentUser();
		return $this->Thread()->canPost($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}
	
	/**
	 * Returns the absolute url rather then relative. Used in Post RSS Feed
	 *
	 * @return String
	 */
	function AbsoluteLink() {

		return Director::absoluteURL($this->Link());
	}

	/**
	 * Return the title of the post. Because we don't have to have the title
	 * on individual posts check with the topic
	 * 
	 * @return String
	 */
	function getTitle() {

		return ($this->isFirstPost()) ? $this->Thread()->Title : sprintf(_t('Post.RESPONSE',"Re: %s",'Post Subject Prefix'),$this->Thread()->Title);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}

	/**
	 * Return the last edited date, if it's different from created
	 */
	function getUpdated() {

		if($this->LastEdited != $this->Created) return $this->LastEdited;
	}
	
	/**
	 * Is this post the first post in the thread. Check if their is a post with an ID less
	 * than the one of this post in the same thread
	 *
	 * @return bool
	 */
	public function isFirstPost() {
		if(empty($this->ThreadID) || empty($this->ID)) return false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		$earlierPosts = DB::query(sprintf(
			'SELECT COUNT("ID") FROM "Post" WHERE "ThreadID" = \'%d\' and "ID" < \'%d\'',
			$this->ThreadID,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$this->ID
		))->value();
		return empty($earlierPosts);
	}
	
	/**
	 * Return a link to edit this post.
	 * 
	 * @return String
	 */
	function EditLink() {

		if ($this->canEdit()) {
			$url = Controller::join_links($this->Link('editpost'), $this->ID);
			return '<a href="' . $url . '" class="editPostLink">' . _t('Post.EDIT', 'Edit') . '</a>';
		}
		return false;
	}

	/**
	 * Return a link to delete this post.
	 * 
	 * If the member is an admin of this forum, (ADMIN permissions
	 * or a moderator) then they can delete the post.
	 *
	 * @return String
	 */
	function DeleteLink() {

		if($this->canDelete()) {
			$url = Controller::join_links($this->Link('deletepost'), $this->ID);
			$token = SecurityToken::inst();
			$url = $token->addToUrl($url);

			$firstPost = ($this->isFirstPost()) ? ' firstPost' : '';

			return '<a class="deleteLink' . $firstPost . '" href="' . $url . '">' . _t('Post.DELETE','Delete') . '</a>';
		}
		
		return false;
	}
	
	/**
	 * Return a link to the reply form. Permission checking is handled on the actual URL
	 * and not on this function
	 *
	 * @return String
	 */
	function ReplyLink() {

		$url = $this->Link('reply');

		return '<a href="' . $url . '" class="replyLink">' . _t('Post.REPLYLINK','Post Reply') . '</a>';
	}
		
	/**
	 * Return a link to the post view.
	 *
	 * @return String
	 */
	function ShowLink() {

		$url = $this->Link('show');
		
		return '<a href="' . $url . '" class="showLink">' . _t('Post.SHOWLINK','Show Thread') . "</a>";
	}
	
	public function BanLink() {

		$thread = $this->Thread();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		if($thread->canModerate()) {
			$link = $thread->Forum()->Link('ban') .'/'. $this->AuthorID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			return "<a class='banLink' href=\"$link\" rel=\"$this->AuthorID\">". _t('Post.BANUSER', 'Ban User') ."</a>";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		}
		return false;
	}

	public function GhostLink() {

		$thread = $this->Thread();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		if($thread->canModerate()) {
			$link = $thread->Forum()->Link('ghost') .'/'. $this->AuthorID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			return "<a class='ghostLink' href=\"$link\" rel=\"$this->AuthorID\">". _t('Post.GHOSTUSER', 'Ghost User') ."</a>";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		}
		return false;
	}

	/**
	 * Return the parsed content and the information for the 
	 * RSS feed
	 */
	function getRSSContent() {

		return $this->renderWith('Includes/Post_rss');
	}

	
	function getRSSAuthor() {

		$author = $this->Author();

		
		return $author->Nickname;
	}
	
	/**
	 * Return a link to show this post
	 *
	 * @return String
	 */
	function Link($action = "show") {

		// only include the forum thread ID in the URL if we're showing the thread either 
		// by showing the posts or replying therwise we only need to pass a single ID.
		$includeThreadID = ($action == "show" || $action == "reply") ? true : false;
		$link = $this->Thread()->Link($action, $includeThreadID);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

		// calculate what page results the post is on
		// the count is the position of the post in the thread
		$count = DB::query("
			SELECT COUNT(\"ID\") 
			FROM \"Post\" 
			WHERE \"ThreadID\" = '$this->ThreadID' AND \"Status\" = 'Moderated' AND \"ID\" < $this->ID
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		")->value();

		$start = ($count >= Forum::$posts_per_page) ? floor($count / Forum::$posts_per_page) * Forum::$posts_per_page : 0;

		$pos = ($start == 0 ? '' : "?start=$start") . ($count == 0 ? '' : "#post{$this->ID}");
		
		return ($action == "show") ? $link . $pos : $link;
	}
}

/**
 * Attachments for posts (one post can have many attachments)
 *
 * @package forum
 */
class Post_Attachment extends File {
	
	private static $has_one = array(

		"Post" => "Post"
	);
	
	private static $defaults = array(

		'ShowInSearch' => 0
	);

	/**
	 * Can a user delete this attachment
	 *
	 * @return bool
	 */
	function canDelete($member = null) {

		if(!$member) $member = Member::currentUser();
		return ($this->Post()) ? $this->Post()->canDelete($member) : true;
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}
	
	/**
	 * Can a user edit this attachement
	 *
	 * @return bool
	 */
	function canEdit($member = null) {

		if(!$member) $member = Member::currentUser();
		return ($this->Post()) ? $this->Post()->canEdit($member) : true;
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}

	/**
	 * Allows the user to download a file without right-clicking
	 */
	function download() {

		if(isset($this->urlParams['ID'])) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$SQL_ID = Convert::raw2sql($this->urlParams['ID']);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			
			if(is_numeric($SQL_ID)) {
				$file = DataObject::get_by_id("Post_Attachment", $SQL_ID);
				$response = SS_HTTPRequest::send_file(file_get_contents($file->getFullPath()), $file->Name);
				$response->output();
			}
		}
		
		return $this->redirectBack();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
	}
}


1			<?php
2
3			/**
4			* Forum Post Object. Contains a single post by the user. A thread is generated
5			* with multiple posts.
6			*
7			* @package forum
8			*/
9
10			class Post extends DataObject {
11
12			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-21 03:14 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
13			"Content" => "Text",
14			"Status" => "Enum('Awaiting, Moderated, Rejected, Archived', 'Moderated')",
15			);
16
17			private static $casting = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-21 03:14 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
18			"Updated" => "SS_Datetime",
19			"RSSContent" => "HTMLText",
20			"RSSAuthor" => "Varchar",
21			"Content" => "HTMLText"
22			);
23
24			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-21 03:14 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
25			"Author" => "Member",
26			"Thread" => "ForumThread",
27			"Forum" => "Forum" // denormalized data but used for read speed
28			);
29
30			private static $has_many = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-21 03:14 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
31			"Attachments" => "Post_Attachment"
32			);
33
34			private static $summary_fields = array(
			0 ignored issues – show Comprehensibility introduced 2015-12-20 22:00 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
35			"Content.LimitWordCount" => "Summary",

silverstripe / silverstripe-forum

Pull Request — master (#186)

Post::GhostLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like