<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Code_Snippets;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Handles exporting snippets from the site in various downloadable formats

[5] Fix | Delete

*

[6] Fix | Delete

* @package Code_Snippets

[7] Fix | Delete

* @since 3.0.0

[8] Fix | Delete

*/

[9] Fix | Delete

class Export {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Array of snippet data fetched from the database

[13] Fix | Delete

*

[14] Fix | Delete

* @var Snippet[]

[15] Fix | Delete

*/

[16] Fix | Delete

protected array $snippets_list;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Class constructor

[20] Fix | Delete

*

[21] Fix | Delete

* @param array<int> $ids List of snippet IDs to export.

[22] Fix | Delete

* @param boolean|null $network Whether to fetch snippets from local or network table.

[23] Fix | Delete

*/

[24] Fix | Delete

public function __construct( array $ids, ?bool $network = null ) {

[25] Fix | Delete

$this->snippets_list = get_snippets( $ids, $network );

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Build the export filename.

[30] Fix | Delete

*

[31] Fix | Delete

* @param string $format File format. Used for file extension.

[32] Fix | Delete

*

[33] Fix | Delete

* @return string

[34] Fix | Delete

*/

[35] Fix | Delete

public function build_filename( string $format ): string {

[36] Fix | Delete

if ( 1 === count( $this->snippets_list ) ) {

[37] Fix | Delete

// If there is only snippet to export, use its name instead of the site name.

[38] Fix | Delete

$title = strtolower( $this->snippets_list[0]->name );

[39] Fix | Delete

} else {

[40] Fix | Delete

// Otherwise, use the site name as set in Settings > General.

[41] Fix | Delete

$title = strtolower( get_bloginfo( 'name' ) );

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

$filename = "$title.code-snippets.$format";

[45] Fix | Delete

return apply_filters( 'code_snippets/export/filename', $filename, $title, $this->snippets_list );

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Bundle snippets together into JSON format.

[50] Fix | Delete

*

[51] Fix | Delete

* @return array<string, string|Snippet[]> Snippets as JSON object.

[52] Fix | Delete

*/

[53] Fix | Delete

public function create_export_object(): array {

[54] Fix | Delete

$snippets = array();

[55] Fix | Delete

[56] Fix | Delete

foreach ( $this->snippets_list as $snippet ) {

[57] Fix | Delete

$snippets[] = array_map(

[58] Fix | Delete

function ( $value ) {

[59] Fix | Delete

return is_string( $value ) ?

[60] Fix | Delete

str_replace( "\r\n", "\n", $value ) :

[61] Fix | Delete

$value;

[62] Fix | Delete

},

[63] Fix | Delete

$snippet->get_modified_fields()

[64] Fix | Delete

);

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

return array(

[68] Fix | Delete

'generator' => 'Code Snippets v' . code_snippets()->version,

[69] Fix | Delete

'date_created' => gmdate( 'Y-m-d H:i' ),

[70] Fix | Delete

'snippets' => $snippets,

[71] Fix | Delete

);

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Bundle a snippets into a PHP file.

[76] Fix | Delete

*/

[77] Fix | Delete

public function export_snippets_php(): string {

[78] Fix | Delete

$result = "<?php\n";

[79] Fix | Delete

[80] Fix | Delete

foreach ( $this->snippets_list as $snippet ) {

[81] Fix | Delete

$code = trim( $snippet->code );

[82] Fix | Delete

[83] Fix | Delete

if ( ( 'php' !== $snippet->type && 'html' !== $snippet->type ) || ! $code ) {

[84] Fix | Delete

continue;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

$result .= "\n/**\n * $snippet->display_name\n";

[88] Fix | Delete

[89] Fix | Delete

if ( ! empty( $snippet->desc ) ) {

[90] Fix | Delete

// Convert description to PhpDoc.

[91] Fix | Delete

$desc = wp_strip_all_tags( str_replace( "\n", "\n * ", $snippet->desc ) );

[92] Fix | Delete

$result .= " *\n * $desc\n";

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$result .= " */\n";

[96] Fix | Delete

[97] Fix | Delete

if ( 'content' === $snippet->scope ) {

[98] Fix | Delete

$shortcode_tag = apply_filters( 'code_snippets_export_shortcode_tag', "code_snippets_export_$snippet->id", $snippet );

[99] Fix | Delete

[100] Fix | Delete

$code = sprintf(

[101] Fix | Delete

"add_shortcode( '%s', function () {\n\tob_start();\n\t?>\n\n\t%s\n\n\t<?php\n\treturn ob_get_clean();\n} );",

[102] Fix | Delete

$shortcode_tag,

[103] Fix | Delete

str_replace( "\n", "\n\t", $code )

[104] Fix | Delete

);

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

$result .= "$code\n";

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

return $result;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Export conditions in JSON format.

[115] Fix | Delete

*

[116] Fix | Delete

* @return string

[117] Fix | Delete

*/

[118] Fix | Delete

public function export_conditions_json(): string {

[119] Fix | Delete

$conditions_data = [];

[120] Fix | Delete

$fields_to_copy = [ 'name', 'desc', 'tags' ];

[121] Fix | Delete

[122] Fix | Delete

foreach ( $this->snippets_list as $snippet ) {

[123] Fix | Delete

$condition_data = [];

[124] Fix | Delete

[125] Fix | Delete

if ( ! $snippet->code || 'cond' !== $snippet->type ) {

[126] Fix | Delete

continue;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

$rules = json_decode( $snippet->code, false );

[130] Fix | Delete

[131] Fix | Delete

if ( json_last_error() !== JSON_ERROR_NONE ) {

[132] Fix | Delete

continue;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

foreach ( $fields_to_copy as $field ) {

[136] Fix | Delete

if ( ! empty( $snippet->$field ) ) {

[137] Fix | Delete

$condition_data[ $field ] = $snippet->$field;

[138] Fix | Delete

}

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

$condition_data['rules'] = $rules;

[142] Fix | Delete

$conditions_data[] = $condition_data;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return wp_json_encode( 1 === count( $conditions_data ) ? $conditions_data[0] : $conditions_data, JSON_PRETTY_PRINT );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Generate a downloadable CSS or JavaScript file from a list of snippets

[150] Fix | Delete

*

[151] Fix | Delete

* @phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped

[152] Fix | Delete

*

[153] Fix | Delete

* @param string|null $type Snippet type. Supports 'css' or 'js'.

[154] Fix | Delete

*/

[155] Fix | Delete

public function export_snippets_code( ?string $type = null ): string {

[156] Fix | Delete

$result = '';

[157] Fix | Delete

[158] Fix | Delete

if ( ! $type ) {

[159] Fix | Delete

$type = $this->snippets_list[0]->type;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

if ( 'php' === $type || 'html' === $type ) {

[163] Fix | Delete

return $this->export_snippets_php();

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

if ( 'cond' === $type ) {

[167] Fix | Delete

return $this->export_conditions_json();

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

foreach ( $this->snippets_list as $snippet ) {

[171] Fix | Delete

$snippet = new Snippet( $snippet );

[172] Fix | Delete

[173] Fix | Delete

if ( $snippet->type !== $type ) {

[174] Fix | Delete

continue;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$result .= "\n/*\n";

[178] Fix | Delete

[179] Fix | Delete

if ( $snippet->name ) {

[180] Fix | Delete

$result .= wp_strip_all_tags( $snippet->name ) . "\n\n";

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

if ( ! empty( $snippet->desc ) ) {

[184] Fix | Delete

$result .= wp_strip_all_tags( $snippet->desc ) . "\n";

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

$result .= "*/\n\n$snippet->code\n\n";

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

return $result;

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete