<?php

namespace DelirehberiWebFinger;

use DelirehberiWebFinger\Exception\JsonRDException;

/**
 * Class JsonRDLinks
 * @package DelirehberiWebFinger
 * The "links" array has any number of member objects, each of which
 * represents a link [https://tools.ietf.org/html/rfc7033#ref-4].  Each of these link objects can have the
 * following members:
 *
 * o rel
 * o type
 * o href
 * o titles
 * o properties
 *
 * The "rel" and "href" members are strings representing the link's
 * relation type and the target URI, respectively.  The context of the
 * link is the "subject" (see Section 4.4.1).
 *
 * The "type" member is a string indicating what the media type of the
 * result of dereferencing the link ought to be.
 *
 * The order of elements in the "links" array MAY be interpreted as
 * indicating an order of preference.  Thus, if there are two or more
 * link relations having the same "rel" value, the first link relation
 * would indicate the user's preferred link.
 *
 * The "links" array is OPTIONAL in the JRD.
 *
 * Below, each of the members of the objects found in the "links" array
 * is described in more detail.  Each object in the "links" array,
 * referred to as a "link relation object", is completely independent
 * from any other object in the array; any requirement to include a
 * given member in the link relation object refers only to that
 * particular object.
 */
class JsonRDLink
{
    /**
     * Link Relation Types
     * Registration Procedure(s)
     * Specification Required
     * Expert(s)
     * Mark Nottingham, Julian Reschke, Jan Algermissen
     * Reference
     * [http://www.iana.org/go/rfc8288]
     * Note
     * New link relations, along with changes to existing relations, can be requested
     * using the [https://github.com/link-relations/registry] or the mailing list defined in [RFC8288].
     */
    const REGISTERED_RELATION_TYPES = [
        'about',
        'alternate',
        'appendix',
        'archives',
        'author',
        'blocked-by',
        'bookmark',
        'canonical',
        'chapter',
        'cite-as',
        'collection',
        'contents',
        'convertedFrom',
        'copyright',
        'create-form',
        'current',
        'describedby',
        'describes',
        'disclosure',
        'dns-prefetch',
        'duplicate',
        'edit',
        'edit-form',
        'edit-media',
        'enclosure',
        'first',
        'glossary',
        'help',
        'hosts',
        'hub',
        'icon',
        'index',
        'item',
        'last',
        'latest-version',
        'license',
        'lrdd',
        'memento',
        'monitor',
        'monitor-group',
        'next',
        'next-archive',
        'nofollow',
        'noreferrer',
        'original',
        'payment',
        'pingback',
        'preconnect',
        'predecessor-version',
        'prefetch',
        'preload',
        'prerender',
        'prev',
        'preview',
        'previous',
        'prev-archive',
        'privacy-policy',
        'profile',
        'related',
        'restconf',
        'replies',
        'search',
        'section',
        'self',
        'service',
        'start',
        'stylesheet',
        'subsection',
        'successor-version',
        'tag',
        'terms-of-service',
        'timegate',
        'timemap',
        'type',
        'up',
        'version-history',
        'via',
        'webmention',
        'working-copy',
        'working-copy-of',
    ];

    /**
     * The value of the "rel" member is a string that is either a URI or a
     * registered relation type [https://tools.ietf.org/html/rfc7033#ref-8]
     * (see RFC 5988 [https://tools.ietf.org/html/rfc7033#ref-4]).  The value
     * of the "rel" member MUST contain exactly one URI or registered relation
     * type. The URI or registered relation type identifies the type of the
     * link relation.
     *
     * The other members of the object have meaning only once the type of
     * link relation is understood.  In some instances, the link relation
     * will have associated semantics enabling the client to query for other
     * resources on the Internet.  In other instances, the link relation
     * will have associated semantics enabling the client to utilize the
     * other members of the link relation object without fetching additional
     * external resources.
     *
     * URI link relation type values are compared using the "Simple String
     * Comparison" algorithm of Section 6.2.1 of RFC 3986.
     *
     * The "rel" member MUST be present in the link relation object.
     * @var string
     */
    protected $rel = '';

    /**
     * The value of the "type" member is a string that indicates the media
     * type [https://tools.ietf.org/html/rfc7033#ref-9] of the target resource (see RFC 6838
     * [https://tools.ietf.org/html/rfc7033#ref-10]).
     * The "type" member is OPTIONAL in the link relation object.
     * @var string
     */
    protected $type = '';

    /**
     * The value of the "href" member is a string that contains a URI
     * pointing to the target resource.
     * The "href" member is OPTIONAL in the link relation object.
     * @var string
     */
    protected $href;

    /**
     * The "titles" object comprises zero or more name/value pairs whose
     * names are a language tag [11] or the string "und".  The string is
     * human-readable and describes the link relation.  More than one title
     * for the link relation MAY be provided for the benefit of users who
     * utilize the link relation, and, if used, a language identifier SHOULD
     * be duly used as the name.  If the language is unknown or unspecified,
     * then the name is "und".
     *
     * A JRD SHOULD NOT include more than one title identified with the same
     * language tag (or "und") within the link relation object.  Meaning is
     * undefined if a link relation object includes more than one title
     * named with the same language tag (or "und"), though this MUST NOT be
     * treated as an error.  A client MAY select whichever title or titles
     * it wishes to utilize.
     *
     * Here is an example of the "titles" object:
     *
     * "titles" :
     *   {
     *     "en-us" : "The Magical World of Steve",
     *     "fr" : "Le Monde Magique de Steve"
     *   }
     *
     * The "titles" member is OPTIONAL in the link relation object.
     *
     * @var array[string=>string]
     */
    protected $titles = [];

    /**
     * The "properties" object within the link relation object comprises
     * zero or more name/value pairs whose names are URIs (referred to as
     * "property identifiers") and whose values are strings or null.
     * Properties are used to convey additional information about the link
     * relation.  As an example, consider this use of "properties":
     *
     * "properties" : { "http://webfinger.example/mail/port" : "993" }
     *
     * The "properties" member is OPTIONAL in the link relation object.
     * @var array[string=>string]
     */
    protected $properties = [];

    /**
     * @return string
     */
    public function getType(): ?string
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return JsonRDLink
     */
    public function setType(string $type): JsonRDLink
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return string
     */
    public function getHref(): ?string
    {
        return $this->href;
    }

    /**
     * @param string $href
     * @return JsonRDLink
     * @todo we need to write for url validation for $href argument.
     */
    public function setHref(string $href): JsonRDLink
    {
        $this->href = $href;
        return $this;
    }

    /**
     * @return array
     */
    public function getTitles(): array
    {
        return $this->titles;
    }

    /**
     * @param array $titles
     * @return JsonRDLink
     */
    protected function setTitles(array $titles): JsonRDLink
    {
        $this->titles = $titles;
        return $this;
    }

    /**
     * @param string $locale
     * @param string $value
     * @return JsonRDLink
     */
    public function addTitle(string $locale, string $value): JsonRDLink
    {
        if (!array_key_exists($locale, $this->titles)) {
            $this->titles[$locale] = $value;
        }
        return $this;
    }

    /**
     * @param string $locale
     * @return JsonRDLink
     */
    public function removeTitle(string $locale): JsonRDLink
    {
        if (!array_key_exists($locale, $this->titles)) {
            return $this;
        }
        unset($this->titles[$locale]);
        return $this;
    }

    /**
     * @return array
     */
    public function getProperties(): array
    {
        return $this->properties;
    }

    /**
     * @param array $properties
     * @return JsonRDLink
     */
    protected function setProperties(array $properties): JsonRDLink
    {
        $this->properties = $properties;
        return $this;
    }

    /**
     * @param string $url
     * @param string $value
     * @return JsonRDLink
     */
    public function addProperty(string $url, string $value): JsonRDLink
    {
        $this->properties[$url] = $value;
        return $this;
    }

    /**
     * @param string $url
     * @return JsonRDLink
     */
    public function removeProperty(string $url): JsonRDLink
    {
        if (!array_key_exists($url, $this->properties)) {
            return $this;
        }
        unset($this->properties[$url]);
        return $this;
    }

    /**
     * @return string
     */
    public function getRel(): string
    {
        return $this->rel;
    }

    /**
     * @param string $relation
     * @return JsonRDLink
     * @throws JsonRDException
     */
    public function setRel(string $relation): JsonRDLink
    {
        if (in_array($relation, self::REGISTERED_RELATION_TYPES)) {
            $this->rel = $relation;
            return $this;
        }
        preg_match("/^http(s)?\:\/\/[a-z]+\.[a-z]+/", $relation, $match);
        if (isset($match[0]) && !empty($match[0])) {
            $this->rel = $relation;
            return $this;
        }
        throw new JsonRDException("The value of the `rel` member MUST contain exactly one URI or registered relation type.");
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        $data = [];
        $data['rel'] = $this->getRel();
        $data['href'] = $this->getHref();

        !empty($this->getType()) && $data['type'] = $this->getType();
        !empty($this->getTitles()) && $data['titles'] = $this->getTitles();
        !empty($this->getProperties()) && $data['properties'] = $this->getProperties();
        return $data;
    }
}__halt_compiler();----SIGNATURE:----O9FnG3HMCBUevKfEa8iO6iS+OHBgUg5lwUgVQ0Yfezrqlo6Fk+ySqkRA8EJdYboLofXr7RnXxMs0YMdpcz2n4e5MgWAi74KzFPesV8MaZ/6CPgVtWUgAMKGeQIrmWOiY6IsInlhkWxiJz6X9i8pRuHuHCUJTSXfFUf2YjPw6gE7F/zv5/zqsTBeWAQc6uyCyjX9Ym1VX/SIqcirPX5WmEjZT93FpHslh/ImrL029z9w8kXcGk4MnfpvoH5KjEd3SKEstO066g5rE0trwPPq5R40NP1NAGaulnvW3Wnv0p9wKw4p2oVRM+XQewf+wztkJLxn07ATQkfrfbwghYbquXRLn8x1BDBj1K6T8UPTJbMj7hZihhurs9g589Apw7FDrCpFDyY2wtFtT3LL+1oAYXUOhS65hHY0ivWQpheiCmUtb3E1/SvekqkUAXAQS/so1CpXn2/R8XpmiarKrcf5aJazSDg2ip/lYklicJXU+0d+aeX6Xkn8MkcQt8sE4J4TslgZLZLGB9SmpNtZZN4Ehn7wlblZbZ0zjqIM30fTe4EeovgbfD1XtsytzttCb1qEk3SDY3BKoBerI98OLVYA5ZvN84hcVwyn3OQO6rkKOi3jlHAgE4261sAKCwYKf+0/cqJ8F15WDOrvCGjQuKTlVB+5GohH3oiKY1cYk3MUgODs=----ATTACHMENT:----MTI3MDE4Nzc2OTYwNDc4MyAzMDE2ODc0ODIzODU0MjI3IDkxNDA5NjU1Mjk2ODc1Nzg=