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

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

admin-site-enhancements / classes Last commit date

class-common-methods.php

173 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	if ( !is_null( $string ) ) {
64	$string = preg_replace( '@<(\\w+)\\b.?>.?</\\1>@si', '', $string );
65	}
66	// Strip any remaining HTML or PHP tags
67	$string = strip_tags( $string );
68	return $string;
69	}
70
71	/**
72	* Get menu hidden by toggle
73	*
74	* @since 5.1.0
75	*/
76	public function get_menu_hidden_by_toggle()
77	{
78	$menu_hidden_by_toggle = array();
79	$options = get_option( ASENHA_SLUG_U, array() );
80
81	if ( array_key_exists( 'custom_menu_hidden', $options ) ) {
82	$menu_hidden = $options['custom_menu_hidden'];
83	$menu_hidden = explode( ',', $menu_hidden );
84	$menu_hidden_by_toggle = array();
85	foreach ( $menu_hidden as $menu_id ) {
86	$menu_hidden_by_toggle[] = $this->restore_menu_item_id( $menu_id );
87	}
88	}
89
90	return $menu_hidden_by_toggle;
91	}
92
93	/**
94	* Get user capabilities for which the "Show All/Less" menu toggle should be shown for
95	*
96	* @since 5.1.0
97	*/
98	public function get_user_capabilities_to_show_menu_toggle_for()
99	{
100	global $menu ;
101	$menu_always_hidden = array();
102	$user_capabilities_menus_are_hidden_for = array();
103	$menu_hidden_by_toggle = $this->get_menu_hidden_by_toggle();
104	// indexed array
105	foreach ( $menu as $menu_key => $menu_info ) {
106	foreach ( $menu_hidden_by_toggle as $hidden_menu_id ) {
107
108	if ( false !== strpos( $menu_info[4], 'wp-menu-separator' ) ) {
109	$menu_item_id = $menu_info[2];
110	} else {
111	$menu_item_id = $menu_info[5];
112	}
113
114	$menu_item_id_transformed = $this->transform_menu_item_id( $menu_item_id );
115	if ( $menu_item_id_transformed == $hidden_menu_id ) {
116	$user_capabilities_menus_are_hidden_for[] = $menu_info[1];
117	}
118	}
119	}
120	$user_capabilities_menus_are_hidden_for = array_unique( $user_capabilities_menus_are_hidden_for );
121	return $user_capabilities_menus_are_hidden_for;
122	// indexed array
123	}
124
125	/**
126	* Transform menu item's ID
127	*
128	* @since 5.1.0
129	*/
130	public function transform_menu_item_id( $menu_item_id )
131	{
132	// Transform e.g. edit.php?post_type=page ==> edit__php___post_type____page
133	$menu_item_id_transformed = str_replace( array(
134	".",
135	"?",
136	"=",
137	"&",
138	"/"
139	), array(
140	"__",
141	"___",
142	"____",
143	"_____",
144	"______"
145	), $menu_item_id );
146	return $menu_item_id_transformed;
147	}
148
149	/**
150	* Transform menu item's ID
151	*
152	* @since 5.1.0
153	*/
154	public function restore_menu_item_id( $menu_item_id_transformed )
155	{
156	// Transform e.g. edit__php___post_type____page ==> edit.php?post_type=page
157	$menu_item_id = str_replace( array(
158	"______",
159	"_____",
160	"____",
161	"___",
162	"__"
163	), array(
164	"/",
165	"&",
166	"=",
167	"?",
168	"."
169	), $menu_item_id_transformed );
170	return $menu_item_id;
171	}
172
173	}