Pinterest\Objects\Pin

Complexity

Total Complexity

1

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	fields()	0	17	1

<?php

/*
 * This file is part of the Pinterest PHP library.
 *
 * (c) Hans Ott <hansott@hotmail.be>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.md.
 *
 * Source: https://github.com/hansott/pinterest-php
 */

namespace Pinterest\Objects;

/**
 * This class represents a pin.
 *
 * @author Hans Ott <hansott@hotmail.be>
 */
final class Pin implements BaseObject
{
    /**
     * The required fields.
     *
     * @return array The required fields.
     */
    public static function fields()
    {
        return array(
            'id',
            'link',
            'url',
            'board',
            'created_at',
            'note',
            'color',
            'counts',
            'media',
            'attribution',
            'image',
            'metadata',
        );
    }

    /**
     * The Pin's id.
     *
     * @var string
     * @required
     */
    public $id;

    /**
     * The URL of the web page where the Pin was created.
     *
     * @var string
     */
    public $link;

    /**
     * The url to the object on pinterest.
     *
     * @var string
     */
    public $url;

    /**
     * The board the Pin is in.
     *
     * @var Board
     */
    public $board;

    /**
     * ISO 8601 Timestamp of creation date.
     *
     * @var \DateTime
     */
    public $created_at;

    /**
     * The description of the Pin by the creator.
     *
     * @var string
     */
    public $note;

    /**
     * The dominant color of the Pin image.
     *
     * @var string
     */
    public $color;

    /**
     * The stats/counts of the Pin (saves and comments).
     *
     * @var Stats
     */
    public $counts;

    /**
     * Information about the media type, including whether it's an "image" or "video".
     *
     * @var array
     */
    public $media;

    /**
     * Attribution information.
     *
     * @var array
     */
    public $attribution;

    /**
     * The images that represents the Pin. This is determined by the request.
     *
     * @var array
     */
    public $image;

    /**
     * Extra information including Pin type (recipe, article, etc.) and related data (ingredients, author, etc).
     *
     * @var array
     */
    public $metadata;
}