Arcanedev\Json\Contracts\Json

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
	setFilesystem()	0	1	?
	getPath()	0	1	?
	setPath()	0	1	?
	attributes()	0	1	?
	decode()	0	1	?
	encode()	0	1	?
	make()	0	1	?
	fromContent()	0	1	?
	get()	0	1	?
	set()	0	1	?
	merge()	0	1	?
	update()	0	1	?
	save()	0	1	?
	toJsonPretty()	0	1	?

<?php namespace Arcanedev\Json\Contracts;

use Illuminate\Filesystem\Filesystem;

/**
 * Interface  Json
 *
 * @package   Arcanedev\Json\Contracts
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface Json
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the filesystem instance.
     *
     * @param  \Illuminate\Filesystem\Filesystem  $filesystem
     *
     * @return static
     */
    public function setFilesystem(Filesystem $filesystem);

    /**
     * Get path.
     *
     * @return string
     */
    public function getPath();

    /**
     * Set path.
     *
     * @param  mixed  $path
     *
     * @return static
     */
    public function setPath($path);

    /**
     * Get file contents as Collection.
     *
     * @return \Illuminate\Support\Collection
     */
    public function attributes();

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Decode ths json content.
     *
     * @param  string  $content
     * @param  bool    $assoc
     * @param  int     $depth
     * @param  int     $options
     *
     * @return array
     */
    public static function decode($content, $assoc = true, $options = 0, $depth = 512);

    /**
     * Encode to json content.
     *
     * @param  mixed  $content
     * @param  int    $options
     * @param  int    $depth
     *
     * @return string
     */
    public function encode($content, $options = 0, $depth = 512);

    /**
     * Make new instance.
     *
     * @param  string                             $path
     * @param  \Illuminate\Filesystem\Filesystem  $filesystem
     *
     * @return static
     */
    public static function make($path, Filesystem $filesystem = null);

    /**
     * Load json content.
     *
     * @param  string  $content
     *
     * @return static
     */
    public static function fromContent($content);

    /**
     * Get the specified attribute from json file.
     *
     * @param  string      $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function get($key, $default = null);

    /**
     * Set a specific key & value.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @return static
     */
    public function set($key, $value);

    /**
     * Merge json attributes with a given array items.
     *
     * @param  array  $items
     *
     * @return static
     */
    public function merge(array $items);

    /**
     * Update & save json contents from array items.
     *
     * @param  array   $items
     * @param  string  $path
     *
     * @return int
     */
    public function update(array $items, $path = null);

    /**
     * Save the current attributes array to the file storage.
     *
     * @param  string|null  $path
     *
     * @return int
     */
    public function save($path = null);

    /**
     * Convert the given array data to pretty json.
     *
     * @param  array  $data
     *
     * @return string
     */
    public function toJsonPretty(array $data = null);
}