class-common-methods.php — Admin and Site Enhancements (ASE) 6.3.2

admin-site-enhancements / classes / class-common-methods.php

admin-site-enhancements / classes Last commit date

class-common-methods.php

199 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	/**
6	* Class that provides common methods used throughout the plugin
7	*
8	* @since 2.5.0
9	*/
10	class Common_Methods
11	{
12	/**
13	* Get IP of the current visitor/user. In use by at least the Limit Login Attempts feature.
14	*
15	* @since 2.5.0
16	*/
17	public function get_user_ip_address()
18	{
19
20	if ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
21	$ip_address = sanitize_text_field( $_SERVER['REMOTE_ADDR'] );
22	} elseif ( isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
23	$ip_address = sanitize_text_field( $_SERVER['HTTP_X_FORWARDED_FOR'] );
24	} elseif ( isset( $_SERVER['HTTP_CLIENT_IP'] ) ) {
25	$ip_address = sanitize_text_field( $_SERVER['HTTP_CLIENT_IP'] );
26	} else {
27	$ip_address = '0.0.0.0';
28	}
29
30	return $ip_address;
31	}
32
33	/**
34	* Convert number of seconds into hours, minutes, seconds. In use by at least the Limit Login Attempts feature.
35	*
36	* @since 2.5.0
37	*/
38	public function seconds_to_period( $seconds, $conversion_type )
39	{
40	$period_start = new \DateTime( '@0' );
41	$period_end = new \DateTime( "@{$seconds}" );
42
43	if ( $conversion_type == 'to-days-hours-minutes-seconds' ) {
44	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
45	} elseif ( $conversion_type == 'to-hours-minutes-seconds' ) {
46	return $period_start->diff( $period_end )->format( '%h hours, %i minutes and %s seconds' );
47	} elseif ( $conversion_type == 'to-minutes-seconds' ) {
48	return $period_start->diff( $period_end )->format( '%i minutes and %s seconds' );
49	} else {
50	return $period_start->diff( $period_end )->format( '%a days, %h hours, %i minutes and %s seconds' );
51	}
52
53	}
54
55	/**
56	* Remove html tags and content inside the tags from a string
57	*
58	* @since 3.0.3
59	*/
60	public function strip_html_tags_and_content( $string )
61	{
62	// Strip HTML tags and content inside them. Ref: https://stackoverflow.com/a/39320168
63
64	if ( !is_null( $string ) ) {
65	$string = preg_replace( '@<(\\w+)\\b.?>.?</\\1>@si', '', $string );
66	// Strip any remaining HTML or PHP tags
67	$string = strip_tags( $string );
68	}
69
70	return $string;
71	}
72
73	/**
74	* Get menu hidden by toggle
75	*
76	* @since 5.1.0
77	*/
78	public function get_menu_hidden_by_toggle()
79	{
80	$menu_hidden_by_toggle = array();
81	$options = get_option( ASENHA_SLUG_U, array() );
82
83	if ( array_key_exists( 'custom_menu_hidden', $options ) ) {
84	$menu_hidden = $options['custom_menu_hidden'];
85	$menu_hidden = explode( ',', $menu_hidden );
86	$menu_hidden_by_toggle = array();
87	foreach ( $menu_hidden as $menu_id ) {
88	$menu_hidden_by_toggle[] = $this->restore_menu_item_id( $menu_id );
89	}
90	}
91
92	return $menu_hidden_by_toggle;
93	}
94
95	/**
96	* Get user capabilities for which the "Show All/Less" menu toggle should be shown for
97	*
98	* @since 5.1.0
99	*/
100	public function get_user_capabilities_to_show_menu_toggle_for()
101	{
102	global $menu ;
103	$menu_always_hidden = array();
104	$user_capabilities_menus_are_hidden_for = array();
105	$menu_hidden_by_toggle = $this->get_menu_hidden_by_toggle();
106	// indexed array
107	foreach ( $menu as $menu_key => $menu_info ) {
108	foreach ( $menu_hidden_by_toggle as $hidden_menu_id ) {
109
110	if ( false !== strpos( $menu_info[4], 'wp-menu-separator' ) ) {
111	$menu_item_id = $menu_info[2];
112	} else {
113	$menu_item_id = $menu_info[5];
114	}
115
116	if ( $menu_item_id == $hidden_menu_id ) {
117	$user_capabilities_menus_are_hidden_for[] = $menu_info[1];
118	}
119	}
120	}
121	$user_capabilities_menus_are_hidden_for = array_unique( $user_capabilities_menus_are_hidden_for );
122	return $user_capabilities_menus_are_hidden_for;
123	// indexed array
124	}
125
126	/**
127	* Transform menu item's ID
128	*
129	* @since 5.1.0
130	*/
131	public function transform_menu_item_id( $menu_item_id )
132	{
133	// Transform e.g. edit.php?post_type=page ==> edit__php___post_type____page
134	$menu_item_id_transformed = str_replace( array(
135	".",
136	"?",
137	"=/",
138	"=",
139	"&",
140	"/"
141	), array(
142	"__",
143	"___",
144	"_______",
145	"____",
146	"_____",
147	"______"
148	), $menu_item_id );
149	return $menu_item_id_transformed;
150	}
151
152	/**
153	* Transform menu item's ID
154	*
155	* @since 5.1.0
156	*/
157	public function restore_menu_item_id( $menu_item_id_transformed )
158	{
159	// Transform e.g. edit__php___post_type____page ==> edit.php?post_type=page
160	$menu_item_id = str_replace( array(
161	"_______",
162	"______",
163	"_____",
164	"____",
165	"___",
166	"__"
167	), array(
168	"=/",
169	"/",
170	"&",
171	"=",
172	"?",
173	"."
174	), $menu_item_id_transformed );
175	return $menu_item_id;
176	}
177
178	/**
179	* Sanitize hexedecimal numbers used for colors
180	*
181	* @link https://plugins.trac.wordpress.org/browser/bm-custom-login/trunk/bm-custom-login.php
182	* @param string $color Hex number to sanitize.
183	* @return string
184	*/
185	public function sanitize_hex_color( $color )
186	{
187	if ( '' === $color ) {
188	return '';
189	}
190	// Make sure the color starts with a hash.
191	$color = '#' . ltrim( $color, '#' );
192	// 3 or 6 hex digits, or the empty string.
193	if ( preg_match( '\|^#([A-Fa-f0-9]{3}){1,2}$\|', $color ) ) {
194	return $color;
195	}
196	return null;
197	}
198
199	}