ShortList

Complexity

Total Complexity

7

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	Link()	0	4	1
A	isBrowser()	0	9	1
B	onBeforeWrite()	0	35	5

<?php

/**
 * @file
 * This is the model for the short list URLs.
 */

/**
 * A model to store the short list of items and a unique URL.
 */
class ShortList extends DataObject
{

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Fields.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

Tabs must be used to indent lines; spaces are not allowed

        'SessionID'     => 'varchar(64)',

Tabs must be used to indent lines; spaces are not allowed

        'URL'           => 'Varchar(255)',

Tabs must be used to indent lines; spaces are not allowed

        'UserAgent'     => 'Varchar(512)'

Tabs must be used to indent lines; spaces are not allowed

    );

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Attaches to many items.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    private static $has_many = array(

Consider using a different property name as you override a private property of the parent class.

Tabs must be used to indent lines; spaces are not allowed

        'ShortListItems' => 'ShortListItem'

Tabs must be used to indent lines; spaces are not allowed

    );

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Where the URL is unique.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    private static $indexes = array(

Consider using a different property name as you override a private property of the parent class.

Tabs must be used to indent lines; spaces are not allowed

        'UniqueURL'     => array(

Tabs must be used to indent lines; spaces are not allowed

            'type'      => 'unique',

Tabs must be used to indent lines; spaces are not allowed

            'value'     => 'URL'

Tabs must be used to indent lines; spaces are not allowed

        )

Tabs must be used to indent lines; spaces are not allowed

    );

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * Ensure we populate these fields before a save.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function onBeforeWrite()

Tabs must be used to indent lines; spaces are not allowed

    {

Opening brace should be on the same line as the declaration

Tabs must be used to indent lines; spaces are not allowed

        // Run other beforewrites first.

Tabs must be used to indent lines; spaces are not allowed

        parent::onBeforeWrite();

Tabs must be used to indent lines; spaces are not allowed

        // if (!$this->isBrowser()) {

70% of this comment could be valid code. Did you maybe forget this after debugging?

Tabs must be used to indent lines; spaces are not allowed

        //     return false;

Tabs must be used to indent lines; spaces are not allowed

        // }

Tabs must be used to indent lines; spaces are not allowed

        // If this is the first save...

Tabs must be used to indent lines; spaces are not allowed

        if (!$this->isInDB()) {

Tabs must be used to indent lines; spaces are not allowed

            // Ensure the session exists before querying it.

Tabs must be used to indent lines; spaces are not allowed

            if (!Session::request_contains_session_id()) {

Tabs must be used to indent lines; spaces are not allowed

                Session::start();

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            // Store the sesion and in the database.

Tabs must be used to indent lines; spaces are not allowed

            $this->SessionID = SecurityToken::inst()->getValue();

Tabs must be used to indent lines; spaces are not allowed

            if (is_null($this->SessionID)) {

The property SessionID does not exist on object<ShortList>. Since you implemented __get, maybe consider adding a @property annotation.

Tabs must be used to indent lines; spaces are not allowed

                return false;

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            $gen = new RandomGenerator();

Tabs must be used to indent lines; spaces are not allowed

            $uniqueurl = substr($gen->randomToken(), 0, 32);

Tabs must be used to indent lines; spaces are not allowed

            while (ShortList::get()->filter('URL', $uniqueurl)->count() > 0) {

As per coding style, self should be used for accessing local static members.

Tabs must be used to indent lines; spaces are not allowed

                $uniqueurl = substr($gen->randomToken(), 0, 32);

Tabs must be used to indent lines; spaces are not allowed

            }

Tabs must be used to indent lines; spaces are not allowed

            $this->URL = $uniqueurl;

The property URL does not exist on object<ShortList>. Since you implemented __set, maybe consider adding a @property annotation.

Tabs must be used to indent lines; spaces are not allowed

            $this->UserAgent = Controller::curr()->getRequest()->getHeader('User-Agent');

The property UserAgent does not exist on object<ShortList>. Since you implemented __set, maybe consider adding a @property annotation.

Tabs must be used to indent lines; spaces are not allowed

        }

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * All URLs are prefixed with URLSegment from config.

Tabs must be used to indent lines; spaces are not allowed

     */

Tabs must be used to indent lines; spaces are not allowed

    public function Link($action = null)

The parameter $action is not used and could be removed.

Tabs must be used to indent lines; spaces are not allowed

    {

Opening brace should be on the same line as the declaration

Tabs must be used to indent lines; spaces are not allowed

        return Config::inst()->get('ShortList', 'URLSegment').$this->URL;

The property URL does not exist on object<ShortList>. Since you implemented __get, maybe consider adding a @property annotation.

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

    /**

Tabs must be used to indent lines; spaces are not allowed

     * A basic browser detection.

Tabs must be used to indent lines; spaces are not allowed

     * * if a browser is not here - assume it's a crawler or a bot. In which case, it shouldn't create a shortlist.

Tabs must be used to indent lines; spaces are not allowed

     *

Tabs must be used to indent lines; spaces are not allowed

     * @see http://stackoverflow.com/a/1537636

Tabs must be used to indent lines; spaces are not allowed

     * */

Tabs must be used to indent lines; spaces are not allowed

    public static function isBrowser()

Tabs must be used to indent lines; spaces are not allowed

    {

Opening brace should be on the same line as the declaration

Tabs must be used to indent lines; spaces are not allowed

        // Regular expression to match common browsers

Tabs must be used to indent lines; spaces are not allowed

        $browserlist = '/(opera|aol|msie|firefox|chrome|konqueror|safari|netscape|navigator|mosaic|lynx|amaya|omniweb|avant|camino|flock|seamonkey|mozilla|gecko)+/i';

This line exceeds maximum limit of 120 characters; contains 166 characters

Tabs must be used to indent lines; spaces are not allowed

        $userAgent = strtolower(Controller::curr()->getRequest()->getHeader('User-Agent'));

Tabs must be used to indent lines; spaces are not allowed

        return preg_match($browserlist, $userAgent) === 1;

Tabs must be used to indent lines; spaces are not allowed

    }

Tabs must be used to indent lines; spaces are not allowed

}