Service::field() - Code Metrics - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Service::field()
last analyzed 2016-11-04 16:23 UTC

↳ Parent: Service

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
c	0
b	0
f	0

<?php

namespace HM\BackUpWordPress;

/**
 * An abstract service class, individual services should
 * extend this class
 */
abstract class Service {

	/**
	 * Human readable name for this service
	 * @var string
	 */
	public $name;

	/**
	 * The instance Backup_Schedule that this service is
	 * is currently working with
	 *
	 * @var Scheduled_Backup
	 */
	protected $schedule;

	public function __construct( Scheduled_Backup $schedule ) {
		$this->set_schedule( $schedule );
	}

	/**
	 * Used to determine if the service is in use or not
	 *
	 * @return boolean
	 */
	abstract public function is_service_active();

	/**
	 * The form to output as part of the schedule settings
	 *
	 * If you don't want a whole form return ''; here and use @field instead
	 *
	 * @return string    The raw HTML for the form you want to output
	 */
	abstract public function form();

	/**
	 * The field to output as part of the schedule settings
	 *
	 * If you don't want a field return ''; here and use @form instead
	 *
	 * @return string    The raw HTML for the field you want to output
	 */
	abstract public function field();

	/**
	 * Help text that should be output in the Constants help tab
	 *
	 * @return string    The raw HTML for the Constant help text you want to output

	 */
	public static function constant() {}

	/**
	 * Validate and sanitize data before it's saved.
	 *
	 * @param  array &$new_data An array or data from $_GET, passed by reference so it can be modified,
	 * @param  array $old_data  The old data thats going to be overwritten
	 * @return array $error     Array of validation errors e.g. return array( 'email' => 'not valid' );
	 */
	abstract public function update( &$new_data, $old_data );

	/**
	 * The string to be output as part of the schedule sentence
	 *
	 * @return string
	 */
	abstract public function display();

	/**
	 * Receives actions from the backup
	 *
	 * This is where the service should do it's thing
	 *
	 * @see  Backup::do_action for a list of the actions
	 *
	 * @param $action
	 * @param Backup $backup
	 *
	 * @return mixed
	 */
	public function action( $action, Backup $backup ) {}

	public function get_slug() {

		return sanitize_key( $this->name );
	}

	/**
	 * Utility for getting a formated html input name attribute
	 *
	 * @param  string $name The name of the field
	 * @return string       The formated name
	 */
	protected function get_field_name( $name ) {
		return esc_attr( $this->get_slug() . '[' . $name . ']' );
	}

	/**
	 * Get the value of a field
	 *
	 * @param string $name The name of the field
	 * @param string $esc  The escaping function that should be used
	 * @return string
	 */
	protected function get_field_value( $name, $esc = 'esc_attr' ) {

		if ( $name && $this->schedule->get_service_options( $this->get_slug(), $name ) ) {
			return $esc( $this->schedule->get_service_options( $this->get_slug(), $name ) );
		}

		return '';

	}

	/**
	 * Save the settings for this service
	 *
	 * @return null|array returns null on success, array of errors on failure
	 */
	public function save() {

		$classname = $this->get_slug();

		$old_data = $this->schedule->get_service_options( $classname );

		$new_data = isset( $_POST[ $classname ] ) ? $_POST[ $classname ] : array();

		// $new_data is passed by ref, so it is clean after this method call.
		$errors = $this->update( $new_data, $old_data );

		if ( $errors && $errors = array_flip( $errors ) ) {


			foreach ( $errors as $error => &$field ) {
				$field = $this->get_slug() . '[' . $field . ']';
			}

			return array_flip( $errors );

		}

		// Only overwrite settings if they changed
		if ( ! empty( $new_data ) ) {
			$this->schedule->set_service_options( $classname, $new_data );
		}

		return array();

	}

	/**
	 * Set the current schedule object
	 *
	 * @param Scheduled_Backup $schedule An instantiated schedule object
	 */
	public function set_schedule( Scheduled_Backup $schedule ) {
		$this->schedule = $schedule;
	}

	/**
	 * Gets the settings for a similar destination from the existing schedules
	 * so that we can copy them into the form to avoid having to type them again
	 *
	 * @return array
	 */
	protected function fetch_destination_settings() {

		$service = $this->get_slug();

		$schedules_obj = Schedules::get_instance();

		$schedules = $schedules_obj->get_schedules();

		foreach ( $schedules as $schedule ) {

			if ( $schedule->get_id() != $this->schedule->get_id() ) {

				$options = $schedule->get_service_options( $service );

				if ( ! empty( $options ) ) {
					return $options;
				}
			}
		}

		return array();

	}

	/**
	 * @return boolean
	 */
	public function has_form() {

		ob_start();

		$this->form();

		return (bool) ob_get_clean();

	}

	/**
	 * Handles passing service specific data to Intercom
	 */
	public static function intercom_data() {}

	public static function intercom_data_html() {}
}


1			<?php
2
3			namespace HM\BackUpWordPress;
4
5			/**
6			* An abstract service class, individual services should
7			* extend this class
8			*/
9			abstract class Service {
10
11			/**
12			* Human readable name for this service
13			* @var string
14			*/
15			public $name;
16
17			/**
18			* The instance Backup_Schedule that this service is
19			* is currently working with
20			*
21			* @var Scheduled_Backup
22			*/
23			protected $schedule;
24
25			public function __construct( Scheduled_Backup $schedule ) {
26			$this->set_schedule( $schedule );
27			}
28
29			/**
30			* Used to determine if the service is in use or not
31			*
32			* @return boolean
33			*/
34			abstract public function is_service_active();
35
36			/**
37			* The form to output as part of the schedule settings
38			*
39			* If you don't want a whole form return ''; here and use @field instead
40			*
41			* @return string The raw HTML for the form you want to output
42			*/
43			abstract public function form();
44
45			/**
46			* The field to output as part of the schedule settings
47			*
48			* If you don't want a field return ''; here and use @form instead
49			*
50			* @return string The raw HTML for the field you want to output
51			*/
52			abstract public function field();
53
54			/**
55			* Help text that should be output in the Constants help tab
56			*
57			* @return string The raw HTML for the Constant help text you want to output
			0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
58			*/
59			public static function constant() {}
60
61			/**
62			* Validate and sanitize data before it's saved.
63			*
64			* @param array &$new_data An array or data from $_GET, passed by reference so it can be modified,
65			* @param array $old_data The old data thats going to be overwritten
66			* @return array $error Array of validation errors e.g. return array( 'email' => 'not valid' );
67			*/
68			abstract public function update( &$new_data, $old_data );
69
70			/**
71			* The string to be output as part of the schedule sentence
72			*
73			* @return string
74			*/
75			abstract public function display();
76
77			/**
78			* Receives actions from the backup
79			*
80			* This is where the service should do it's thing
81			*
82			* @see Backup::do_action for a list of the actions
83			*
84			* @param $action
85			* @param Backup $backup
86			*
87			* @return mixed
88			*/
89			public function action( $action, Backup $backup ) {}
90
91			public function get_slug() {
			0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
92			return sanitize_key( $this->name );
93			}
94
95			/**
96			* Utility for getting a formated html input name attribute
97			*
98			* @param string $name The name of the field
99			* @return string The formated name
100			*/
101			protected function get_field_name( $name ) {
102			return esc_attr( $this->get_slug() . '[' . $name . ']' );
103			}
104
105			/**
106			* Get the value of a field
107			*
108			* @param string $name The name of the field
109			* @param string $esc The escaping function that should be used
110			* @return string
111			*/
112			protected function get_field_value( $name, $esc = 'esc_attr' ) {
113
114			if ( $name && $this->schedule->get_service_options( $this->get_slug(), $name ) ) {
115			return $esc( $this->schedule->get_service_options( $this->get_slug(), $name ) );
116			}
117
118			return '';
119
120			}
121
122			/**
123			* Save the settings for this service
124			*
125			* @return null\|array returns null on success, array of errors on failure
126			*/
127			public function save() {
128
129			$classname = $this->get_slug();
130
131			$old_data = $this->schedule->get_service_options( $classname );
132
133			$new_data = isset( $_POST[ $classname ] ) ? $_POST[ $classname ] : array();
134
135			// $new_data is passed by ref, so it is clean after this method call.
136			$errors = $this->update( $new_data, $old_data );
137
138			if ( $errors && $errors = array_flip( $errors ) ) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report The expression `$errors` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
139
140			foreach ( $errors as $error => &$field ) {
141			$field = $this->get_slug() . '[' . $field . ']';
142			}
143
144			return array_flip( $errors );
145
146			}
147
148			// Only overwrite settings if they changed
149			if ( ! empty( $new_data ) ) {
150			$this->schedule->set_service_options( $classname, $new_data );
151			}
152
153			return array();
154
155			}
156
157			/**
158			* Set the current schedule object
159			*
160			* @param Scheduled_Backup $schedule An instantiated schedule object
161			*/
162			public function set_schedule( Scheduled_Backup $schedule ) {
163			$this->schedule = $schedule;
164			}
165
166			/**
167			* Gets the settings for a similar destination from the existing schedules
168			* so that we can copy them into the form to avoid having to type them again
169			*
170			* @return array
171			*/
172			protected function fetch_destination_settings() {
173
174			$service = $this->get_slug();
175
176			$schedules_obj = Schedules::get_instance();
177
178			$schedules = $schedules_obj->get_schedules();
179
180			foreach ( $schedules as $schedule ) {
181
182			if ( $schedule->get_id() != $this->schedule->get_id() ) {
183
184			$options = $schedule->get_service_options( $service );
185
186			if ( ! empty( $options ) ) {
187			return $options;
188			}
189			}
190			}
191
192			return array();
193
194			}
195
196			/**
197			* @return boolean
198			*/
199			public function has_form() {
200
201			ob_start();
202
203			$this->form();
204
205			return (bool) ob_get_clean();
206
207			}
208
209			/**
210			* Handles passing service specific data to Intercom
211			*/
212			public static function intercom_data() {}
213
214			public static function intercom_data_html() {}
215			}
216

humanmade / backupwordpress

GitHub Access Token became invalid

Service::field() last analyzed 2016-11-04 16:23 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Service::field()
last analyzed 2016-11-04 16:23 UTC