allejo\DaPulse\PulseNote

Complexity

Total Complexity

12

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	10
Bugs	0	Features	5

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getType()	0	4	1
A	getId()	0	4	1
A	getTitle()	0	4	1
A	getProjectId()	0	4	1
A	getPermissions()	0	4	1
A	getContent()	0	4	1
A	getCreatedAt()	0	4	1
A	getUpdatedAt()	0	4	1
A	editNote()	0	20	1
A	deleteNote()	0	8	1
A	getNotesUrl()	0	4	1

<?php

namespace allejo\DaPulse;

use allejo\DaPulse\Objects\ApiObject;

class PulseNote extends ApiObject

The property $project_id is not named in camelCase.

The property $created_at is not named in camelCase.

The property $updated_at is not named in camelCase.

{
    const API_PREFIX = "pulses";

    // ================================================================================================================
    //   Instance Variables
    // ================================================================================================================

    /**
     * The collaboration box type (rich_text, file_list, faq_list).
     *
     * @var string
     */
    protected $type;

    /**
     * The note's id.
     *
     * @var string
     */
    protected $id;

    /**
     * The note's title.
     *
     * @var string
     */
    protected $title;

    /**
     * The note's project_id.
     *
     * @var string
     */
    protected $project_id;

    /**
     * Describes who can edit this note. Can be either 'everyone' or 'owners'.
     *
     * @var string
     */
    protected $permissions;

    /**
     * The note's body
     *
     * @var string
     */
    protected $content;

    /**
     * Creation time.
     *
     * @var \DateTime
     */
    protected $created_at;

    /**
     * Last update time.
     *
     * @var \DateTime
     */
    protected $updated_at;

    public function __construct ($array)
    {
        $this->arrayConstructionOnly = true;

        parent::__construct($array);
    }

    // ================================================================================================================
    //   Getter functions
    // ================================================================================================================

    /**
     * The collaboration box type (rich_text, file_list, faq_list).
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * The note's id.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * The note's title.
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * The note's project_id.
     *
     * @return string
     */
    public function getProjectId()
    {
        return $this->project_id;
    }

    /**
     * Describes who can edit this note. Can be either 'everyone' or 'owners'.
     *
     * @return string
     */
    public function getPermissions()
    {
        return $this->permissions;
    }

    /**
     * The note's body.
     *
     * @return string
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Creation time.
     *
     * @return \DateTime
     */
    public function getCreatedAt()
    {
        return $this->created_at;
    }

    /**
     * Last update time.
     *
     * @return \DateTime
     */
    public function getUpdatedAt()
    {
        return $this->updated_at;
    }

    // ================================================================================================================
    //   Modification functions
    // ================================================================================================================

    public function editNote ($title = NULL, $content = NULL, $user_id = NULL, $create_update = NULL)

The parameter $user_id is not named in camelCase.

The parameter $create_update is not named in camelCase.

    {
        $this->checkInvalid();

        $url        = $this->getNotesUrl();
        $postParams = array(
            "id"      => $this->getProjectId(),
            "note_id" => $this->getId()
        );

        self::setIfNotNullOrEmpty($postParams, "title", $title);
        self::setIfNotNullOrEmpty($postParams, "content", $content);
        self::setIfNotNullOrEmpty($postParams, "user_id", $user_id);
        self::setIfNotNullOrEmpty($postParams, "create_update", $create_update);

        $this->jsonResponse = self::sendPut($url, $postParams);

It seems like self::sendPut($url, $postParams) of type * is incompatible with the declared type array of property $jsonResponse.

        $this->assignResults();

        return $this;
    }

    public function deleteNote ()
    {
        $this->checkInvalid();

        self::sendDelete($this->getNotesUrl());

        $this->deletedObject = true;
    }

    private function getNotesUrl ()
    {
        return sprintf("%s/%s/notes/%s.json", self::apiEndpoint(), $this->getProjectId(), $this->getId());
    }
}