Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* @author OnTheGo Systems

[3] Fix | Delete

[4] Fix | Delete

class WPML_Notice {

[5] Fix | Delete

private $display_callbacks = array();

[6] Fix | Delete

private $id;

[7] Fix | Delete

private $text;

[8] Fix | Delete

private $collapsed_text;

[9] Fix | Delete

private $group = 'default';

[10] Fix | Delete

private $restricted_to_user_ids = array();

[11] Fix | Delete

[12] Fix | Delete

private $actions = array();

[13] Fix | Delete

/**

[14] Fix | Delete

* @see \WPML_Notice::set_css_class_types

[15] Fix | Delete

* @var array

[16] Fix | Delete

[17] Fix | Delete

private $css_class_types = array();

[18] Fix | Delete

private $css_classes = array();

[19] Fix | Delete

private $dismissible = false;

[20] Fix | Delete

private $exclude_from_pages = array();

[21] Fix | Delete

private $hideable = false;

[22] Fix | Delete

private $collapsable = false;

[23] Fix | Delete

private $restrict_to_pages = array();

[24] Fix | Delete

private $restrict_to_page_prefixes = array();

[25] Fix | Delete

private $restrict_to_screen_ids = array();

[26] Fix | Delete

private $hide_if_notice_exists = null;

[27] Fix | Delete

private $dismissible_for_different_text = true;

[28] Fix | Delete

[29] Fix | Delete

private $default_group_name = 'default';

[30] Fix | Delete

[31] Fix | Delete

private $capabilities = array();

[32] Fix | Delete

[33] Fix | Delete

private $dismiss_reset = false;

[34] Fix | Delete

[35] Fix | Delete

[36] Fix | Delete

* @var bool

[37] Fix | Delete

* @since 4.1.0

[38] Fix | Delete

[39] Fix | Delete

private $flash = false;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

private $nonce_action;

[45] Fix | Delete

[46] Fix | Delete

/** @var bool */

[47] Fix | Delete

private $text_only = false;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* WPML_Admin_Notification constructor.

[51] Fix | Delete

[52] Fix | Delete

* @param int|string $id

[53] Fix | Delete

* @param string $text

[54] Fix | Delete

* @param string $group

[55] Fix | Delete

[56] Fix | Delete

public function __construct( $id, $text, $group = 'default' ) {

[57] Fix | Delete

$this->id = $id;

[58] Fix | Delete

$this->text = $text;

[59] Fix | Delete

$this->group = $group ? $group : $this->default_group_name;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

public function add_action( WPML_Notice_Action $action ) {

[63] Fix | Delete

$this->actions[] = $action;

[64] Fix | Delete

[65] Fix | Delete

if ( $action->can_dismiss() ) {

[66] Fix | Delete

$this->dismissible = true;

[67] Fix | Delete

}

[68] Fix | Delete

if ( ! $action->can_dismiss_different_text() ) {

[69] Fix | Delete

$this->dismissible_for_different_text = false;

[70] Fix | Delete

}

[71] Fix | Delete

if ( $action->can_hide() ) {

[72] Fix | Delete

$this->hideable = true;

[73] Fix | Delete

}

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

public function add_exclude_from_page( $page ) {

[77] Fix | Delete

$this->exclude_from_pages[] = $page;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

public function add_restrict_to_page( $page ) {

[81] Fix | Delete

$this->restrict_to_pages[] = $page;

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/** @param int $user_id */

[85] Fix | Delete

public function add_user_restriction( $user_id ) {

[86] Fix | Delete

$user_id = (int) $user_id;

[87] Fix | Delete

$this->restricted_to_user_ids[ $user_id ] = $user_id;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/** @param int $user_id */

[91] Fix | Delete

public function remove_user_restriction( $user_id ) {

[92] Fix | Delete

unset( $this->restricted_to_user_ids[ (int) $user_id ] );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/** @return array */

[96] Fix | Delete

public function get_restricted_user_ids() {

[97] Fix | Delete

return $this->restricted_to_user_ids;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/** @return bool */

[101] Fix | Delete

public function is_user_restricted() {

[102] Fix | Delete

return (bool) $this->restricted_to_user_ids;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/** @return bool */

[106] Fix | Delete

public function is_for_current_user() {

[107] Fix | Delete

return ! $this->restricted_to_user_ids

[108] Fix | Delete

|| array_key_exists( get_current_user_id(), $this->restricted_to_user_ids );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* @return bool

[113] Fix | Delete

[114] Fix | Delete

public function is_user_cap_allowed() {

[115] Fix | Delete

$user_can = true;

[116] Fix | Delete

foreach ( $this->capabilities as $cap ) {

[117] Fix | Delete

$user_can = current_user_can( $cap );

[118] Fix | Delete

[119] Fix | Delete

if ( $user_can ) {

[120] Fix | Delete

break;

[121] Fix | Delete

}

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

return $user_can;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

public function can_be_dismissed() {

[128] Fix | Delete

return $this->dismissible;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

public function can_be_dismissed_for_different_text() {

[132] Fix | Delete

return $this->dismissible_for_different_text;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

public function can_be_hidden() {

[136] Fix | Delete

return $this->hideable;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* @return bool

[141] Fix | Delete

[142] Fix | Delete

public function can_be_collapsed() {

[143] Fix | Delete

return $this->collapsable;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* As the notice is supposed to be serialized and stored into the DB,

[148] Fix | Delete

* the callback should be only a function or a static method.

[149] Fix | Delete

[150] Fix | Delete

* Before to use a callback, please check the existing options with:

[151] Fix | Delete

* - add_exclude_from_page

[152] Fix | Delete

* - add_restrict_to_page

[153] Fix | Delete

* - add_user_restriction

[154] Fix | Delete

* - add_capability_check

[155] Fix | Delete

[156] Fix | Delete

* @param callable $callback

[157] Fix | Delete

[158] Fix | Delete

public function add_display_callback( $callback ) {

[159] Fix | Delete

if ( ! is_callable( $callback ) ) {

[160] Fix | Delete

throw new UnexpectedValueException( '\WPML_Notice::add_display_callback expects a callable', 1 );

[161] Fix | Delete

}

[162] Fix | Delete

$this->display_callbacks[] = $callback;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

public function add_capability_check( array $cap ) {

[166] Fix | Delete

$this->capabilities = $cap;

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

public function get_display_callbacks() {

[170] Fix | Delete

return $this->display_callbacks;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

public function get_actions() {

[174] Fix | Delete

return $this->actions;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

public function get_css_classes() {

[178] Fix | Delete

return $this->css_classes;

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

/**

[182] Fix | Delete

* @param string|array $css_classes

[183] Fix | Delete

[184] Fix | Delete

public function set_css_classes( $css_classes ) {

[185] Fix | Delete

if ( ! is_array( $css_classes ) ) {

[186] Fix | Delete

$css_classes = explode( ' ', $css_classes );

[187] Fix | Delete

}

[188] Fix | Delete

$this->css_classes = $css_classes;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

public function get_exclude_from_pages() {

[192] Fix | Delete

return $this->exclude_from_pages;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* @return string

[197] Fix | Delete

[198] Fix | Delete

public function get_group() {

[199] Fix | Delete

return $this->group;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* @return int|string

[204] Fix | Delete

[205] Fix | Delete

public function get_id() {

[206] Fix | Delete

return $this->id;

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

public function set_restrict_to_page_prefixes( array $page_prefixes ) {

[210] Fix | Delete

$this->restrict_to_page_prefixes = $page_prefixes;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* @return array

[215] Fix | Delete

[216] Fix | Delete

public function get_restrict_to_page_prefixes() {

[217] Fix | Delete

return $this->restrict_to_page_prefixes;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

public function get_restrict_to_pages() {

[221] Fix | Delete

return $this->restrict_to_pages;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

public function set_restrict_to_screen_ids( array $screens ) {

[225] Fix | Delete

$this->restrict_to_screen_ids = $screens;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* @return array

[230] Fix | Delete

[231] Fix | Delete

public function get_restrict_to_screen_ids() {

[232] Fix | Delete

return $this->restrict_to_screen_ids;

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

public function get_nonce_action() {

[236] Fix | Delete

return $this->nonce_action;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* @return string

[241] Fix | Delete

[242] Fix | Delete

public function get_text() {

[243] Fix | Delete

$notice = array( 'id' => $this->get_id(), 'group' => $this->get_group() );

[244] Fix | Delete

$this->text = apply_filters( 'wpml_notice_text', $this->text, $notice );

[245] Fix | Delete

return $this->text;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

public function get_css_class_types() {

[249] Fix | Delete

return $this->css_class_types;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* @return string

[254] Fix | Delete

[255] Fix | Delete

public function get_collapsed_text() {

[256] Fix | Delete

return $this->collapsed_text;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Use this to set the look of the notice.

[261] Fix | Delete

* WordPress recognize these values:

[262] Fix | Delete

* - notice-error

[263] Fix | Delete

* - notice-warning

[264] Fix | Delete

* - notice-success

[265] Fix | Delete

* - notice-info

[266] Fix | Delete

* You can use the above values with or without the "notice-" prefix:

[267] Fix | Delete

* the prefix will be added automatically in the HTML, if missing.

[268] Fix | Delete

* @see https://codex.wordpress.org/Plugin_API/Action_Reference/admin_notices for more details

[269] Fix | Delete

[270] Fix | Delete

* @param string|array $types Accepts either a space separated values string, or an array of values.

[271] Fix | Delete

[272] Fix | Delete

public function set_css_class_types( $types ) {

[273] Fix | Delete

if ( ! is_array( $types ) ) {

[274] Fix | Delete

$types = explode( ' ', $types );

[275] Fix | Delete

}

[276] Fix | Delete

$this->css_class_types = $types;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

/**

[280] Fix | Delete

* @param bool $dismissible

[281] Fix | Delete

[282] Fix | Delete

public function set_dismissible( $dismissible ) {

[283] Fix | Delete

$this->dismissible = $dismissible;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

public function set_exclude_from_pages( array $pages ) {

[287] Fix | Delete

$this->exclude_from_pages = $pages;

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

public function set_hide_if_notice_exists( $notice_id, $notice_group = null ) {

[291] Fix | Delete

$this->hide_if_notice_exists = array(

[292] Fix | Delete

'id' => $notice_id,

[293] Fix | Delete

'group' => $notice_group,

[294] Fix | Delete

);

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

public function get_hide_if_notice_exists( ) {

[298] Fix | Delete

return $this->hide_if_notice_exists;

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

/**

[302] Fix | Delete

* @param bool $hideable

[303] Fix | Delete

[304] Fix | Delete

public function set_hideable( $hideable ) {

[305] Fix | Delete

$this->hideable = $hideable;

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* @param bool $collapsable

[310] Fix | Delete

[311] Fix | Delete

public function set_collapsable( $collapsable ) {

[312] Fix | Delete

$this->collapsable = $collapsable;

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* @param string $action

[317] Fix | Delete

[318] Fix | Delete

public function set_nonce_action( $action ) {

[319] Fix | Delete

$this->nonce_action = $action;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

/**

[323] Fix | Delete

* @param string $collapsed_text

[324] Fix | Delete

[325] Fix | Delete

public function set_collapsed_text( $collapsed_text ) {

[326] Fix | Delete

$this->collapsed_text = $collapsed_text;

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

public function set_restrict_to_pages( array $pages ) {

[330] Fix | Delete

$this->restrict_to_pages = $pages;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

public function reset_dismiss() {

[334] Fix | Delete

$this->dismiss_reset = true;

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

public function must_reset_dismiss() {

[338] Fix | Delete

return $this->dismiss_reset;

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

public function is_different( WPML_Notice $other_notice ) {

[342] Fix | Delete

return serialize( $this ) !== serialize( $other_notice );

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

/**

[346] Fix | Delete

* @param bool $flash

[347] Fix | Delete

* @since 4.1.0

[348] Fix | Delete

[349] Fix | Delete

public function set_flash( $flash = true ){

[350] Fix | Delete

$this->flash = (bool) $flash;

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* @return bool

[355] Fix | Delete

* @since 4.1.0

[356] Fix | Delete

[357] Fix | Delete

public function is_flash(){

[358] Fix | Delete

return $this->flash;

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

/**

[362] Fix | Delete

* @return bool

[363] Fix | Delete

[364] Fix | Delete

public function should_be_text_only() {

[365] Fix | Delete

return $this->text_only;

[366] Fix | Delete

}

[367] Fix | Delete

[368] Fix | Delete

/**

[369] Fix | Delete

* @param bool $text_only

[370] Fix | Delete

[371] Fix | Delete

public function set_text_only( $text_only ) {

[372] Fix | Delete

$this->text_only = $text_only;

[373] Fix | Delete

}

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete