SevenShores\Hubspot\Resources\Files

Complexity

Total Complexity

16

Size/Duplication

Total Lines	224
Duplicated Lines	4.91 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	upload()	0	24	4
A	all()	0	8	1
A	replace()	0	13	1
A	meta()	0	6	1
A	archive()	0	6	1
A	delete()	0	6	1
A	move()	0	8	1
A	createFolder()	11	11	1
A	folders()	0	8	1
A	updateFolder()	0	8	1
A	deleteFolder()	0	6	1
A	getFolderById()	0	6	1
A	moveFolder()	0	8	1

<?php

namespace SevenShores\Hubspot\Resources;

class Files extends Resource
{
    /**
     * Upload a new file.
     *
     * @param string $file   File path
     * @param array  $params Optional parameters
     * @return \SevenShores\Hubspot\Http\Response
     */
    function upload($file, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files";

        $queryString = build_query_string([
            'overwrite' => isset($params['overwrite']) ? $params['overwrite'] : false,
        ]);

        $options['multipart'] = [
            [
                'name' => 'files',
                'contents' => fopen($file, 'rb')
            ],
            [
                'name' => 'file_names',
                'contents' => isset($params['file_names']) ? $params['file_names'] : null
            ],[
                'name' => 'folder_paths',
                'contents' => isset($params['folder_paths']) ? $params['folder_paths'] : null
            ]
        ];

        return $this->client->request('post', $endpoint, $options, $queryString);
    }

    /**
     * Get meta data for all files.
     *
     * @param array $params Optional parameters
     * @return \SevenShores\Hubspot\Http\Response
     */
    function all($params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }


    /**
     * Upload a replacement file.
     *
     * @param int    $file_id The file ID
     * @param string $file    The file path
     * @return \SevenShores\Hubspot\Http\Response
     */
    function replace($file_id, $file)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files/{$file_id}";

        $options['multipart'] = [

$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

            [
                'name' => 'files',
                'contents' => fopen($file, 'rb')
            ]
        ];

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * Get file metadata.
     *
     * @param $file_id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function meta($file_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files/{$file_id}";

        return $this->client->request('get', $endpoint);
    }

    /**
     * Archive a file.
     *
     * @param int $file_id The file ID
     * @return \SevenShores\Hubspot\Http\Response
     */
    function archive($file_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files/{$file_id}/archive";

        return $this->client->request('post', $endpoint);
    }

    /**
     * Delete a file.
     *
     * @param int $file_id The file ID
     * @return \SevenShores\Hubspot\Http\Response
     */
    function delete($file_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files/{$file_id}";

        return $this->client->request('delete', $endpoint);
    }

    /**
     * Move a file to a new folder.
     *
     * Parameters:
     * folder_path  string    The path of the folder to move the file into. Use this OR folder_id - not both.
     * folder_id    string    The id of the folder to move the file into. Use this OR folder_path - not both.
     * name            string    The new name of the file.
     *
     * @param int   $file_id
     * @param array $params
     * @return \SevenShores\Hubspot\Http\Response
     */
    function move($file_id, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/files/{$file_id}/move-file";

        $options['json'] = $params;

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * Create a new folder.
     *
     * @param string $folder_name
     * @param int    $parent_folder_id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function createFolder($folder_name, $parent_folder_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders";

        $options['json'] = [
            'name'             => $folder_name,
            'parent_folder_id' => $parent_folder_id,
        ];

        return $this->client->request('post', $endpoint, $options);
    }

    /**
     * List folders metadata.
     *
     * @param array $params
     * @return \SevenShores\Hubspot\Http\Response
     */
    function folders($params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders";

        $queryString = build_query_string($params);

        return $this->client->request('get', $endpoint, [], $queryString);
    }

    /**
     * Update a folder.
     *
     * @param int   $folder_id
     * @param array $params
     * @return \SevenShores\Hubspot\Http\Response
     */
    function updateFolder($folder_id, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders/{$folder_id}";

        $options['json'] = $params;

        return $this->client->request('put', $endpoint, $options);
    }

    /**
     * Delete a folder.
     *
     * @param int $folder_id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function deleteFolder($folder_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders/{$folder_id}";

        return $this->client->request('delete', $endpoint);
    }

    /**
     * Get the folder by ID.
     *
     * @param int $folder_id
     * @return \SevenShores\Hubspot\Http\Response
     */
    function getFolderById($folder_id)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders/{$folder_id}";

        return $this->client->request('get', $endpoint);
    }

    /**
     * Move a folder.
     *
     * @param int   $folder_id
     * @param array $params
     * @return \SevenShores\Hubspot\Http\Response
     */
    function moveFolder($folder_id, $params = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        $endpoint = "https://api.hubapi.com/filemanager/api/v2/folders/{$folder_id}/move-folder";

        $options['json'] = $params;

$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

        return $this->client->request('post', $endpoint, $options);
    }

}