Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* JSON manger class

[2] Fix | Delete

[3] Fix | Delete

* It handles json output for use on backend and frontend.

[4] Fix | Delete

[5] Fix | Delete

* @package AdvancedAds\Framework

[6] Fix | Delete

* @author Advanced Ads <info@wpadvancedads.com>

[7] Fix | Delete

* @since 1.0.0

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

namespace AdvancedAds\Framework;

[11] Fix | Delete

[12] Fix | Delete

use InvalidArgumentException;

[13] Fix | Delete

[14] Fix | Delete

defined( 'ABSPATH' ) || exit;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* JSON class

[18] Fix | Delete

[19] Fix | Delete

class JSON {

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* JSON Holder.

[23] Fix | Delete

[24] Fix | Delete

* @var array

[25] Fix | Delete

[26] Fix | Delete

private $data = [];

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Default Object name.

[30] Fix | Delete

[31] Fix | Delete

* @var string

[32] Fix | Delete

[33] Fix | Delete

private $default_object_name = null;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* The constructor

[37] Fix | Delete

[38] Fix | Delete

* @param string $object_name Object name to be used.

[39] Fix | Delete

[40] Fix | Delete

public function __construct( $object_name ) {

[41] Fix | Delete

$this->default_object_name = $object_name;

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Bind all hooks.

[46] Fix | Delete

[47] Fix | Delete

* @since 1.0.0

[48] Fix | Delete

[49] Fix | Delete

* @throws InvalidArgumentException When object name not defined.

[50] Fix | Delete

[51] Fix | Delete

* @return void

[52] Fix | Delete

[53] Fix | Delete

public function hooks(): void {

[54] Fix | Delete

if ( empty( $this->default_object_name ) ) {

[55] Fix | Delete

throw new InvalidArgumentException( 'Please set default object name to be used when printing JSON.' );

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

$hook = is_admin() ? 'admin_footer' : 'wp_footer';

[59] Fix | Delete

add_action( $hook, [ $this, 'output' ], 0 );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Add to JSON object.

[64] Fix | Delete

[65] Fix | Delete

* @since 1.0.0

[66] Fix | Delete

[67] Fix | Delete

* @param mixed ...$args Arguments.

[68] Fix | Delete

[69] Fix | Delete

* Parameters can be

[70] Fix | Delete

* 1. array|string Unique identifier or array<key, value>.

[71] Fix | Delete

* 2. array|string The data itself can be either a scalar or an array.

[72] Fix | Delete

* In Case of first param an array this can be object_name.

[73] Fix | Delete

* 3. string Name for the JavaScript object.

[74] Fix | Delete

* Passed directly, so it should be qualified JS variable.

[75] Fix | Delete

[76] Fix | Delete

* @return JSON

[77] Fix | Delete

[78] Fix | Delete

public function add( ...$args ): JSON {

[79] Fix | Delete

list( $key, $value, $object_name ) = $this->get_add_data( $args );

[80] Fix | Delete

[81] Fix | Delete

// Early Bail!!

[82] Fix | Delete

if ( empty( $key ) ) {

[83] Fix | Delete

return $this;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

// If array is passed.

[87] Fix | Delete

if ( is_array( $key ) ) {

[88] Fix | Delete

foreach ( $key as $arr_key => $arr_value ) {

[89] Fix | Delete

$this->add_to_storage( $arr_key, $arr_value, $object_name );

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

return $this;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$this->add_to_storage( $key, $value, $object_name );

[96] Fix | Delete

[97] Fix | Delete

return $this;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Add to storage.

[102] Fix | Delete

[103] Fix | Delete

* @since 1.0.0

[104] Fix | Delete

[105] Fix | Delete

* @param string $key Unique identifier.

[106] Fix | Delete

* @param mixed $value The data itself can be either a single or an array.

[107] Fix | Delete

* @param string $object_name Name for the JavaScript object.

[108] Fix | Delete

* Passed directly, so it should be qualified JS variable.

[109] Fix | Delete

* @return void

[110] Fix | Delete

[111] Fix | Delete

private function add_to_storage( $key, $value, $object_name ): void {

[112] Fix | Delete

// If key doesn't exists.

[113] Fix | Delete

if ( ! isset( $this->data[ $object_name ][ $key ] ) ) {

[114] Fix | Delete

$this->data[ $object_name ][ $key ] = $value;

[115] Fix | Delete

return;

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

// If key already exists.

[119] Fix | Delete

$old_value = $this->data[ $object_name ][ $key ];

[120] Fix | Delete

$is_array = is_array( $old_value ) && is_array( $value );

[121] Fix | Delete

[122] Fix | Delete

$this->data[ $object_name ][ $key ] = $is_array ? array_merge( $old_value, $value ) : $value;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Remove from JSON object.

[127] Fix | Delete

[128] Fix | Delete

* @since 1.0.0

[129] Fix | Delete

[130] Fix | Delete

* @param string $key Unique identifier.

[131] Fix | Delete

* @param string $object_name Name for the JavaScript object.

[132] Fix | Delete

* Passed directly, so it should be qualified JS variable.

[133] Fix | Delete

* @return JSON

[134] Fix | Delete

[135] Fix | Delete

public function remove( $key, $object_name = false ): JSON {

[136] Fix | Delete

// Early Bail!!

[137] Fix | Delete

if ( empty( $key ) ) {

[138] Fix | Delete

return $this;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

if ( empty( $object_name ) ) {

[142] Fix | Delete

$object_name = $this->default_object_name;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

if ( isset( $this->data[ $object_name ][ $key ] ) ) {

[146] Fix | Delete

unset( $this->data[ $object_name ][ $key ] );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return $this;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Clear all data.

[154] Fix | Delete

[155] Fix | Delete

* @since 1.0.0

[156] Fix | Delete

[157] Fix | Delete

* @return JSON

[158] Fix | Delete

[159] Fix | Delete

public function clear_all(): JSON {

[160] Fix | Delete

$this->data = [];

[161] Fix | Delete

$this->data[ $this->default_object_name ] = [];

[162] Fix | Delete

[163] Fix | Delete

return $this;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Print data.

[168] Fix | Delete

[169] Fix | Delete

* @since 1.0.0

[170] Fix | Delete

[171] Fix | Delete

* @return void

[172] Fix | Delete

[173] Fix | Delete

public function output(): void {

[174] Fix | Delete

$script = $this->encode();

[175] Fix | Delete

if ( ! $script ) {

[176] Fix | Delete

return;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5.

[180] Fix | Delete

echo "/* <![CDATA[ */\n";

[181] Fix | Delete

echo "$script\n"; // phpcs:ignore

[182] Fix | Delete

echo "/* ]]> */\n";

[183] Fix | Delete

echo "</script>\n";

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Get encoded string.

[188] Fix | Delete

[189] Fix | Delete

* @since 1.0.0

[190] Fix | Delete

[191] Fix | Delete

* @return string

[192] Fix | Delete

[193] Fix | Delete

private function encode(): string {

[194] Fix | Delete

$script = '';

[195] Fix | Delete

foreach ( $this->data as $object_name => $object_data ) {

[196] Fix | Delete

$script .= $this->single_object( $object_name, $object_data );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

return $script;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Encode single object.

[204] Fix | Delete

[205] Fix | Delete

* @since 1.0.0

[206] Fix | Delete

[207] Fix | Delete

* @param string $object_name Object name to use as JS variable.

[208] Fix | Delete

* @param array $object_data Object data to json encode.

[209] Fix | Delete

[210] Fix | Delete

* @return string

[211] Fix | Delete

[212] Fix | Delete

private function single_object( $object_name, $object_data ): string {

[213] Fix | Delete

if ( empty( $object_data ) ) {

[214] Fix | Delete

return '';

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

foreach ( (array) $object_data as $key => $value ) {

[218] Fix | Delete

if ( ! is_scalar( $value ) ) {

[219] Fix | Delete

continue;

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

$object_data[ $key ] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8' );

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

return "var $object_name = " . wp_json_encode( $object_data ) . ';' . PHP_EOL;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Normalize add arguments

[230] Fix | Delete

[231] Fix | Delete

* @param array $args Arguments array.

[232] Fix | Delete

[233] Fix | Delete

* @return array

[234] Fix | Delete

[235] Fix | Delete

private function get_add_data( $args ): array {

[236] Fix | Delete

$key = $args[0] ?? false;

[237] Fix | Delete

$value = $args[1] ?? false;

[238] Fix | Delete

$object_name = $args[2] ?? $this->default_object_name;

[239] Fix | Delete

[240] Fix | Delete

if ( is_array( $key ) && ! empty( $value ) ) {

[241] Fix | Delete

$object_name = $value;

[242] Fix | Delete

$value = false;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

return [

[246] Fix | Delete

$key,

[247] Fix | Delete

$value,

[248] Fix | Delete

$object_name,

[249] Fix | Delete

];

[250] Fix | Delete

}

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete