gravityview / GravityView

includes/class-admin-installer.php

Indentation +94 added lines, -94 removed lines

@@ -66,9 +66,9 @@ 
 	 */
 	public function add_downloads_data_filters() {
 
-	    $downloads_data = get_site_transient( self::DOWNLOADS_DATA_TRANSIENT );
+		$downloads_data = get_site_transient( self::DOWNLOADS_DATA_TRANSIENT );
 
-	    if ( ! $downloads_data && ! isset( $_GET['cache'] ) ) {
+		if ( ! $downloads_data && ! isset( $_GET['cache'] ) ) {
 			return;
 		}
 
@@ -97,7 +97,7 @@ 
 	 */
 	public function add_admin_menu() {
 
-	    $menu_text = _x( 'Manage Add-Ons', 'Extensions are WordPress plugins that add functionality to GravityView and Gravity Forms', 'gravityview' );
+		$menu_text = _x( 'Manage Add-Ons', 'Extensions are WordPress plugins that add functionality to GravityView and Gravity Forms', 'gravityview' );
 
 		$menu_text = sprintf( '<span title="%s" style="margin: 0">%s</span>', esc_attr__( 'Plugins that extend GravityView and Gravity Forms functionality.', 'gravityview' ), $menu_text );
 
@@ -112,8 +112,8 @@ 
 	}
 
 	/**
-     * When on the Installer page, show a different notice than on the Settings page
-     *
+	 * When on the Installer page, show a different notice than on the Settings page
+	 *
 	 * @param array $notice
 	 *
 	 * @return string License notice
@@ -121,10 +121,10 @@ 
 	public function maybe_modify_license_notice( $notice = '' ) {
 
 		if ( ! gravityview()->request->is_admin( '', 'downloads' ) ) {
-            return $notice;
-        }
+			return $notice;
+		}
 
-        return esc_html__( 'Your license %s. Do you want access to these plugins? %sActivate your license%s or %sget a license here%s.', 'gravityview' );
+		return esc_html__( 'Your license %s. Do you want access to these plugins? %sActivate your license%s or %sget a license here%s.', 'gravityview' );
 	}
 
 	/**
@@ -167,43 +167,43 @@ 
 	 * Get downloads data from transient or from API; save transient after getting data from API
 	 *
 	 * @return WP_Error|array If error, returns WP_Error. If not valid JSON, empty array. Otherwise, this structure: {
-     *   @type array  $info {
-     *       @type string $id int 17
-     *       @type string $slug Extension slug
-     *       @type string $title Extension title
-     *       @type string $create_date in '2018-07-19 20:03:10' format
-     *       @type string $modified_date
-     *       @type string $status
-     *       @type string $link URL to public plugin page
-     *       @type string $content
-     *       @type string $excerpt
-     *       @type string $thumbnail URL to thumbnail
-     *       @type array  $category Taxonomy details for the plugin's category {
-     *         @type int $term_id => int 30
-     *         @type string $name => string 'Plugins' (length=7)
-     *         @type string $slug => string 'plugins' (length=7)
-     *         @type int $term_group => int 0
-     *         @type int $term_taxonomy_id => int 30
-     *         @type string $taxonomy => string 'download_category' (length=17)
-     *         @type string $description => string '' (length=0)
-     *         @type int $parent => int 0
-     *         @type int $count => int 4
-     *         @type string $filter => string 'raw' (length=3)
-     *       }
-     *       @type array $tags {see $category above}
-     *       @type string $textdomain string 'gravityview' (length=11)
-     *   }
-     *   @type array $pricing array of `price_name_slugs` => '00.00' values, if price options exist
-     *   @type array $licensing {
-     *       @type bool   $enabled Is licensing enabled for the extension
-     *       @type string $version Version number
-     *       @type string $exp_unit Expiration unit ('years')
-     *       @type string $exp_length Expiration length ('1')
-     *   }
-     *   @type array $files Array of files. Empty if user has no access to the file. {
-     *       @type string $file string URL of the file download
-     *   }
-     * }
+	 *   @type array  $info {
+	 *       @type string $id int 17
+	 *       @type string $slug Extension slug
+	 *       @type string $title Extension title
+	 *       @type string $create_date in '2018-07-19 20:03:10' format
+	 *       @type string $modified_date
+	 *       @type string $status
+	 *       @type string $link URL to public plugin page
+	 *       @type string $content
+	 *       @type string $excerpt
+	 *       @type string $thumbnail URL to thumbnail
+	 *       @type array  $category Taxonomy details for the plugin's category {
+	 *         @type int $term_id => int 30
+	 *         @type string $name => string 'Plugins' (length=7)
+	 *         @type string $slug => string 'plugins' (length=7)
+	 *         @type int $term_group => int 0
+	 *         @type int $term_taxonomy_id => int 30
+	 *         @type string $taxonomy => string 'download_category' (length=17)
+	 *         @type string $description => string '' (length=0)
+	 *         @type int $parent => int 0
+	 *         @type int $count => int 4
+	 *         @type string $filter => string 'raw' (length=3)
+	 *       }
+	 *       @type array $tags {see $category above}
+	 *       @type string $textdomain string 'gravityview' (length=11)
+	 *   }
+	 *   @type array $pricing array of `price_name_slugs` => '00.00' values, if price options exist
+	 *   @type array $licensing {
+	 *       @type bool   $enabled Is licensing enabled for the extension
+	 *       @type string $version Version number
+	 *       @type string $exp_unit Expiration unit ('years')
+	 *       @type string $exp_length Expiration length ('1')
+	 *   }
+	 *   @type array $files Array of files. Empty if user has no access to the file. {
+	 *       @type string $file string URL of the file download
+	 *   }
+	 * }
 	 */
 	public function get_downloads_data() {
 
@@ -235,7 +235,7 @@ 
 		) );
 
 		if ( is_wp_error( $response ) ) {
-		    gravityview()->log->error( "Extension data response is an error", array( 'data' => $response ) );
+			gravityview()->log->error( "Extension data response is an error", array( 'data' => $response ) );
 			return $response;
 		}
 
@@ -288,10 +288,10 @@ 
                 <div class="gv-admin-installer-notice notice inline error">
                     <h3><?php esc_html_e( 'Extensions and plugins data cannot be loaded at the moment. Please try again later.', 'gravityview' ); ?></h3>
                     <?php
-                    if ( is_wp_error( $downloads_data ) ) {
-	                    echo wpautop( '<pre>' . esc_html( $downloads_data->get_error_message() ) . '</pre>' );
-                    }
-                    ?>
+					if ( is_wp_error( $downloads_data ) ) {
+						echo wpautop( '<pre>' . esc_html( $downloads_data->get_error_message() ) . '</pre>' );
+					}
+					?>
                 </div>
             </div>
 			<?php
@@ -381,9 +381,9 @@ 
 	 */
 	protected function render_download( $download, $wp_plugins ) {
 
-        $details = $this->get_download_display_details( $download, $wp_plugins );
+		$details = $this->get_download_display_details( $download, $wp_plugins );
 
-        $download_info = $details['download_info'];
+		$download_info = $details['download_info'];
 
 		?>
         <div class="item <?php echo esc_attr( $details['item_class'] ); ?>">
@@ -407,45 +407,45 @@ 
 
                 <div class="addon-excerpt"><?php
 
-                    $excerpt = \GV\Utils::get( $download_info, 'installer_excerpt', $download_info['excerpt'] );
+					$excerpt = \GV\Utils::get( $download_info, 'installer_excerpt', $download_info['excerpt'] );
 
-                    // Allow some pure HTML tags, but remove everything else from the excerpt.
-                    $tags = array( '<strong>', '</strong>', '<em>', '</em>', '<code>', '</code>' );
-                    $replacements = array( '[b]', '[/b]', '[i]', '[/i]', '[code]', '[/code]' );
+					// Allow some pure HTML tags, but remove everything else from the excerpt.
+					$tags = array( '<strong>', '</strong>', '<em>', '</em>', '<code>', '</code>' );
+					$replacements = array( '[b]', '[/b]', '[i]', '[/i]', '[code]', '[/code]' );
 
-                    $excerpt = str_replace( $tags, $replacements, $excerpt );
-                    $excerpt = esc_html( strip_tags( $excerpt ) );
+					$excerpt = str_replace( $tags, $replacements, $excerpt );
+					$excerpt = esc_html( strip_tags( $excerpt ) );
 					$excerpt = str_replace( $replacements, $tags, $excerpt );
 
 					echo wpautop( $excerpt );
-                ?></div>
+				?></div>
             </div>
         </div>
 		<?php
 	}
 
 	/**
-     * Generates details array for the download to keep the render_download() method a bit tidier
-     *
+	 * Generates details array for the download to keep the render_download() method a bit tidier
+	 *
 	 * @since 2.10 Allow managing installed add-ons whether or not the user's license shows they have access.
 	 *
 	 * @param array $download Single download, as returned by {@see get_downloads_data}
 	 * @param array $wp_plugins All active plugins, as returned by {@see get_plugins()}
 	 *
 	 * @return array {
-     *   @type array $download_info
-     *   @type string $plugin_path
-     *   @type string $status License status returned by Easy Digital Downloads ("active", "inactive", "expired", "revoked", etc)
-     *   @type string $status_label
-     *   @type string $button_title Title attribute to show when hovering over the download's button
-     *   @type string $button_class CSS class to use for the button
-     *   @type string $button_label Text to use for the download's anchor link
-     *   @type string $href URL for the download's button
-     *   @type bool   $spinner Whether to show the spinner icon
-     *   @type string $item_class CSS class for the download container
-     *   @type string $required_license The name of the required license for the download ("All Access" or "Core + Extensions")
-     *   @type bool   $is_active Is the current GravityView license (as entered in Settings) active?
-     * }
+	 *   @type array $download_info
+	 *   @type string $plugin_path
+	 *   @type string $status License status returned by Easy Digital Downloads ("active", "inactive", "expired", "revoked", etc)
+	 *   @type string $status_label
+	 *   @type string $button_title Title attribute to show when hovering over the download's button
+	 *   @type string $button_class CSS class to use for the button
+	 *   @type string $button_label Text to use for the download's anchor link
+	 *   @type string $href URL for the download's button
+	 *   @type bool   $spinner Whether to show the spinner icon
+	 *   @type string $item_class CSS class for the download container
+	 *   @type string $required_license The name of the required license for the download ("All Access" or "Core + Extensions")
+	 *   @type bool   $is_active Is the current GravityView license (as entered in Settings) active?
+	 * }
 	 */
 	private function get_download_display_details( $download, $wp_plugins ) {
 
@@ -456,7 +456,7 @@ 
 			'slug' => '',
 			'excerpt' => '',
 			'link' => '',
-            'coming_soon' => false,
+			'coming_soon' => false,
 			'installer_title' => null, // May not be defined
 			'installer_excerpt' => null, // May not be defined
 		) );
@@ -500,14 +500,14 @@ 
 			$href         = 'https://www.gravitykit.com/pricing/?utm_source=admin-installer&utm_medium=admin&utm_campaign=Admin%20Notice&utm_content=' . $required_license;
 		}
 
-        elseif ( ! empty( $download_info['coming_soon'] ) ) {
-	        $spinner      = false;
-	        $status       = 'notinstalled';
-	        $status_label = __( 'Coming Soon', 'gravityview' );
-	        $button_label = __( 'Learn More', 'gravityview' );
-	        $button_class = 'button-primary button-large';
-	        $href         = \GV\Utils::get( $download_info, 'link', 'https://www.gravitykit.com/extensions/' );
-        }
+		elseif ( ! empty( $download_info['coming_soon'] ) ) {
+			$spinner      = false;
+			$status       = 'notinstalled';
+			$status_label = __( 'Coming Soon', 'gravityview' );
+			$button_label = __( 'Learn More', 'gravityview' );
+			$button_class = 'button-primary button-large';
+			$href         = \GV\Utils::get( $download_info, 'link', 'https://www.gravitykit.com/extensions/' );
+		}
 
 		// Access but the plugin is not installed
 		elseif ( ! $wp_plugin ) {
@@ -553,18 +553,18 @@ 
 		$download_info['link'] = add_query_arg( array( 'license_key' => $license_key ), $download_info['link'] );
 
 		return compact( 'download_info','plugin_path', 'status', 'status_label', 'button_title', 'button_class', 'button_label', 'href', 'spinner', 'item_class', 'required_license', 'is_active' );
-    }
+	}
 
 	/**
-     * Returns the base price for an extension
-     *
+	 * Returns the base price for an extension
+	 *
 	 * @param array $download
 	 *
 	 * @return float Base price for an extension. If not for sale separately, returns 0
 	 */
 	private function get_download_base_price( $download ) {
 
-	    $base_price = \GV\Utils::get( $download, 'pricing/amount', 0 );
+		$base_price = \GV\Utils::get( $download, 'pricing/amount', 0 );
 		$base_price = \GFCommon::to_number( $base_price );
 
 		unset( $download['pricing']['amount'] );
@@ -575,7 +575,7 @@ 
 		}
 
 		return floatval( $base_price );
-    }
+	}
 
 	/**
 	 * Handle AJAX request to activate extension
@@ -593,8 +593,8 @@ 
 
 		if ( is_wp_error( $result ) || ! is_plugin_active( $data['path'] ) ) {
 			wp_send_json_error( array(
-                'error' => sprintf( __( 'Plugin activation failed: %s', 'gravityview' ), $result->get_error_message() )
-            ) );
+				'error' => sprintf( __( 'Plugin activation failed: %s', 'gravityview' ), $result->get_error_message() )
+			) );
 		}
 
 		wp_send_json_success();
@@ -615,10 +615,10 @@ 
 		deactivate_plugins( $data['path'] );
 
 		if( is_plugin_active( $data['path'] ) ) {
-            wp_send_json_error( array(
-                'error' => sprintf( __( 'Plugin deactivation failed.', 'gravityview' ) )
-            ) );
-        }
+			wp_send_json_error( array(
+				'error' => sprintf( __( 'Plugin deactivation failed.', 'gravityview' ) )
+			) );
+		}
 
 		wp_send_json_success();
 	}

trustedlogin/katzgrau/klogger/src/Logger.php

Indentation +318 added lines, -318 removed lines

@@ -34,322 +34,322 @@
  */

 class Logger extends AbstractLogger

 {

-    /**

-     * KLogger options

-     *  Anything options not considered 'core' to the logging library should be

-     *  settable view the third parameter in the constructor

-     *

-     *  Core options include the log file path and the log threshold

-     *

-     * @var array

-     */

-    protected $options = array (

-        'extension'      => 'txt',

-        'dateFormat'     => 'Y-m-d G:i:s.u',

-        'filename'       => false,

-        'flushFrequency' => false,

-        'prefix'         => 'log_',

-        'logFormat'      => false,

-        'appendContext'  => true,

-    );

-

-    /**

-     * Path to the log file

-     * @var string

-     */

-    private $logFilePath;

-

-    /**

-     * Current minimum logging threshold

-     * @var integer

-     */

-    protected $logLevelThreshold = LogLevel::DEBUG;

-

-    /**

-     * The number of lines logged in this instance's lifetime

-     * @var int

-     */

-    private $logLineCount = 0;

-

-    /**

-     * Log Levels

-     * @var array

-     */

-    protected $logLevels = array(

-        LogLevel::EMERGENCY => 0,

-        LogLevel::ALERT     => 1,

-        LogLevel::CRITICAL  => 2,

-        LogLevel::ERROR     => 3,

-        LogLevel::WARNING   => 4,

-        LogLevel::NOTICE    => 5,

-        LogLevel::INFO      => 6,

-        LogLevel::DEBUG     => 7

-    );

-

-    /**

-     * This holds the file handle for this instance's log file

-     * @var resource

-     */

-    private $fileHandle;

-

-    /**

-     * This holds the last line logged to the logger

-     *  Used for unit tests

-     * @var string

-     */

-    private $lastLine = '';

-

-    /**

-     * Octal notation for default permissions of the log file

-     * @var integer

-     */

-    private $defaultPermissions = 0777;

-

-    /**

-     * Class constructor

-     *

-     * @param string $logDirectory      File path to the logging directory

-     * @param string $logLevelThreshold The LogLevel Threshold

-     * @param array  $options

-     *

-     * @internal param string $logFilePrefix The prefix for the log file name

-     * @internal param string $logFileExt The extension for the log file

-     */

-    public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array())

-    {

-        $this->logLevelThreshold = $logLevelThreshold;

-        $this->options = array_merge($this->options, $options);

-

-        $logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR);

-        if ( ! file_exists($logDirectory)) {

-            mkdir($logDirectory, $this->defaultPermissions, true);

-        }

-

-        if(strpos($logDirectory, 'php://') === 0) {

-            $this->setLogToStdOut($logDirectory);

-            $this->setFileHandle('w+');

-        } else {

-            $this->setLogFilePath($logDirectory);

-            if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) {

-                throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.');

-            }

-            $this->setFileHandle('a');

-        }

-

-        if ( ! $this->fileHandle) {

-            throw new RuntimeException('The file could not be opened. Check permissions.');

-        }

-    }

-

-    /**

-     * @param string $stdOutPath

-     */

-    public function setLogToStdOut($stdOutPath) {

-        $this->logFilePath = $stdOutPath;

-    }

-

-    /**

-     * @param string $logDirectory

-     */

-    public function setLogFilePath($logDirectory) {

-        if ($this->options['filename']) {

-            if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) {

-                $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'];

-            }

-            else {

-                $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension'];

-            }

-        } else {

-            $this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension'];

-        }

-    }

-

-    /**

-     * @param $writeMode

-     *

-     * @internal param resource $fileHandle

-     */

-    public function setFileHandle($writeMode) {

-        $this->fileHandle = fopen($this->logFilePath, $writeMode);

-    }

-

-

-    /**

-     * Class destructor

-     */

-    public function __destruct()

-    {

-        if ($this->fileHandle) {

-            fclose($this->fileHandle);

-        }

-    }

-

-    /**

-     * Sets the date format used by all instances of KLogger

-     *

-     * @param string $dateFormat Valid format string for date()

-     */

-    public function setDateFormat($dateFormat)

-    {

-        $this->options['dateFormat'] = $dateFormat;

-    }

-

-    /**

-     * Sets the Log Level Threshold

-     *

-     * @param string $logLevelThreshold The log level threshold

-     */

-    public function setLogLevelThreshold($logLevelThreshold)

-    {

-        $this->logLevelThreshold = $logLevelThreshold;

-    }

-

-    /**

-     * Logs with an arbitrary level.

-     *

-     * @param mixed $level

-     * @param string $message

-     * @param array $context

-     * @return null

-     */

-    public function log($level, $message, array $context = array())

-    {

-        if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) {

-            return;

-        }

-        $message = $this->formatMessage($level, $message, $context);

-        $this->write($message);

-    }

-

-    /**

-     * Writes a line to the log without prepending a status or timestamp

-     *

-     * @param string $message Line to write to the log

-     * @return void

-     */

-    public function write($message)

-    {

-        if (null !== $this->fileHandle) {

-            if (fwrite($this->fileHandle, $message) === false) {

-                throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.');

-            } else {

-                $this->lastLine = trim($message);

-                $this->logLineCount++;

-

-                if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) {

-                    fflush($this->fileHandle);

-                }

-            }

-        }

-    }

-

-    /**

-     * Get the file path that the log is currently writing to

-     *

-     * @return string

-     */

-    public function getLogFilePath()

-    {

-        return $this->logFilePath;

-    }

-

-    /**

-     * Get the last line logged to the log file

-     *

-     * @return string

-     */

-    public function getLastLogLine()

-    {

-        return $this->lastLine;

-    }

-

-    /**

-     * Formats the message for logging.

-     *

-     * @param  string $level   The Log Level of the message

-     * @param  string $message The message to log

-     * @param  array  $context The context

-     * @return string

-     */

-    protected function formatMessage($level, $message, $context)

-    {

-        if ($this->options['logFormat']) {

-            $parts = array(

-                'date'          => $this->getTimestamp(),

-                'level'         => strtoupper($level),

-                'level-padding' => str_repeat(' ', 9 - strlen($level)),

-                'priority'      => $this->logLevels[$level],

-                'message'       => $message,

-                'context'       => json_encode($context),

-            );

-            $message = $this->options['logFormat'];

-            foreach ($parts as $part => $value) {

-                $message = str_replace('{'.$part.'}', $value, $message);

-            }

-

-        } else {

-            $message = "[{$this->getTimestamp()}] [{$level}] {$message}";

-        }

-

-        if ($this->options['appendContext'] && ! empty($context)) {

-            $message .= PHP_EOL.$this->indent($this->contextToString($context));

-        }

-

-        return $message.PHP_EOL;

-

-    }

-

-    /**

-     * Gets the correctly formatted Date/Time for the log entry.

-     *

-     * PHP DateTime is dump, and you have to resort to trickery to get microseconds

-     * to work correctly, so here it is.

-     *

-     * @return string

-     */

-    private function getTimestamp()

-    {

-        $originalTime = microtime(true);

-        $micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000);

-        $date = new DateTime(date('Y-m-d H:i:s.'.$micro, (int)$originalTime));

-

-        return $date->format($this->options['dateFormat']);

-    }

-

-    /**

-     * Takes the given context and coverts it to a string.

-     *

-     * @param  array $context The Context

-     * @return string

-     */

-    protected function contextToString($context)

-    {

-        $export = '';

-        foreach ($context as $key => $value) {

-            $export .= "{$key}: ";

-            $export .= preg_replace(array(

-                '/=>\s+([a-zA-Z])/im',

-                '/array\(\s+\)/im',

-                '/^  |\G  /m'

-            ), array(

-                '=> $1',

-                'array()',

-                '    '

-            ), str_replace('array (', 'array(', var_export($value, true)));

-            $export .= PHP_EOL;

-        }

-        return str_replace(array('\\\\', '\\\''), array('\\', '\''), rtrim($export));

-    }

-

-    /**

-     * Indents the given string with the given indent.

-     *

-     * @param  string $string The string to indent

-     * @param  string $indent What to use as the indent.

-     * @return string

-     */

-    protected function indent($string, $indent = '    ')

-    {

-        return $indent.str_replace("\n", "\n".$indent, $string);

-    }

+	/**

+	 * KLogger options

+	 *  Anything options not considered 'core' to the logging library should be

+	 *  settable view the third parameter in the constructor

+	 *

+	 *  Core options include the log file path and the log threshold

+	 *

+	 * @var array

+	 */

+	protected $options = array (

+		'extension'      => 'txt',

+		'dateFormat'     => 'Y-m-d G:i:s.u',

+		'filename'       => false,

+		'flushFrequency' => false,

+		'prefix'         => 'log_',

+		'logFormat'      => false,

+		'appendContext'  => true,

+	);

+

+	/**

+	 * Path to the log file

+	 * @var string

+	 */

+	private $logFilePath;

+

+	/**

+	 * Current minimum logging threshold

+	 * @var integer

+	 */

+	protected $logLevelThreshold = LogLevel::DEBUG;

+

+	/**

+	 * The number of lines logged in this instance's lifetime

+	 * @var int

+	 */

+	private $logLineCount = 0;

+

+	/**

+	 * Log Levels

+	 * @var array

+	 */

+	protected $logLevels = array(

+		LogLevel::EMERGENCY => 0,

+		LogLevel::ALERT     => 1,

+		LogLevel::CRITICAL  => 2,

+		LogLevel::ERROR     => 3,

+		LogLevel::WARNING   => 4,

+		LogLevel::NOTICE    => 5,

+		LogLevel::INFO      => 6,

+		LogLevel::DEBUG     => 7

+	);

+

+	/**

+	 * This holds the file handle for this instance's log file

+	 * @var resource

+	 */

+	private $fileHandle;

+

+	/**

+	 * This holds the last line logged to the logger

+	 *  Used for unit tests

+	 * @var string

+	 */

+	private $lastLine = '';

+

+	/**

+	 * Octal notation for default permissions of the log file

+	 * @var integer

+	 */

+	private $defaultPermissions = 0777;

+

+	/**

+	 * Class constructor

+	 *

+	 * @param string $logDirectory      File path to the logging directory

+	 * @param string $logLevelThreshold The LogLevel Threshold

+	 * @param array  $options

+	 *

+	 * @internal param string $logFilePrefix The prefix for the log file name

+	 * @internal param string $logFileExt The extension for the log file

+	 */

+	public function __construct($logDirectory, $logLevelThreshold = LogLevel::DEBUG, array $options = array())

+	{

+		$this->logLevelThreshold = $logLevelThreshold;

+		$this->options = array_merge($this->options, $options);

+

+		$logDirectory = rtrim($logDirectory, DIRECTORY_SEPARATOR);

+		if ( ! file_exists($logDirectory)) {

+			mkdir($logDirectory, $this->defaultPermissions, true);

+		}

+

+		if(strpos($logDirectory, 'php://') === 0) {

+			$this->setLogToStdOut($logDirectory);

+			$this->setFileHandle('w+');

+		} else {

+			$this->setLogFilePath($logDirectory);

+			if(file_exists($this->logFilePath) && !is_writable($this->logFilePath)) {

+				throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.');

+			}

+			$this->setFileHandle('a');

+		}

+

+		if ( ! $this->fileHandle) {

+			throw new RuntimeException('The file could not be opened. Check permissions.');

+		}

+	}

+

+	/**

+	 * @param string $stdOutPath

+	 */

+	public function setLogToStdOut($stdOutPath) {

+		$this->logFilePath = $stdOutPath;

+	}

+

+	/**

+	 * @param string $logDirectory

+	 */

+	public function setLogFilePath($logDirectory) {

+		if ($this->options['filename']) {

+			if (strpos($this->options['filename'], '.log') !== false || strpos($this->options['filename'], '.txt') !== false) {

+				$this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'];

+			}

+			else {

+				$this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['filename'].'.'.$this->options['extension'];

+			}

+		} else {

+			$this->logFilePath = $logDirectory.DIRECTORY_SEPARATOR.$this->options['prefix'].date('Y-m-d').'.'.$this->options['extension'];

+		}

+	}

+

+	/**

+	 * @param $writeMode

+	 *

+	 * @internal param resource $fileHandle

+	 */

+	public function setFileHandle($writeMode) {

+		$this->fileHandle = fopen($this->logFilePath, $writeMode);

+	}

+

+

+	/**

+	 * Class destructor

+	 */

+	public function __destruct()

+	{

+		if ($this->fileHandle) {

+			fclose($this->fileHandle);

+		}

+	}

+

+	/**

+	 * Sets the date format used by all instances of KLogger

+	 *

+	 * @param string $dateFormat Valid format string for date()

+	 */

+	public function setDateFormat($dateFormat)

+	{

+		$this->options['dateFormat'] = $dateFormat;

+	}

+

+	/**

+	 * Sets the Log Level Threshold

+	 *

+	 * @param string $logLevelThreshold The log level threshold

+	 */

+	public function setLogLevelThreshold($logLevelThreshold)

+	{

+		$this->logLevelThreshold = $logLevelThreshold;

+	}

+

+	/**

+	 * Logs with an arbitrary level.

+	 *

+	 * @param mixed $level

+	 * @param string $message

+	 * @param array $context

+	 * @return null

+	 */

+	public function log($level, $message, array $context = array())

+	{

+		if ($this->logLevels[$this->logLevelThreshold] < $this->logLevels[$level]) {

+			return;

+		}

+		$message = $this->formatMessage($level, $message, $context);

+		$this->write($message);

+	}

+

+	/**

+	 * Writes a line to the log without prepending a status or timestamp

+	 *

+	 * @param string $message Line to write to the log

+	 * @return void

+	 */

+	public function write($message)

+	{

+		if (null !== $this->fileHandle) {

+			if (fwrite($this->fileHandle, $message) === false) {

+				throw new RuntimeException('The file could not be written to. Check that appropriate permissions have been set.');

+			} else {

+				$this->lastLine = trim($message);

+				$this->logLineCount++;

+

+				if ($this->options['flushFrequency'] && $this->logLineCount % $this->options['flushFrequency'] === 0) {

+					fflush($this->fileHandle);

+				}

+			}

+		}

+	}

+

+	/**

+	 * Get the file path that the log is currently writing to

+	 *

+	 * @return string

+	 */

+	public function getLogFilePath()

+	{

+		return $this->logFilePath;

+	}

+

+	/**

+	 * Get the last line logged to the log file

+	 *

+	 * @return string

+	 */

+	public function getLastLogLine()

+	{

+		return $this->lastLine;

+	}

+

+	/**

+	 * Formats the message for logging.

+	 *

+	 * @param  string $level   The Log Level of the message

+	 * @param  string $message The message to log

+	 * @param  array  $context The context

+	 * @return string

+	 */

+	protected function formatMessage($level, $message, $context)

+	{

+		if ($this->options['logFormat']) {

+			$parts = array(

+				'date'          => $this->getTimestamp(),

+				'level'         => strtoupper($level),

+				'level-padding' => str_repeat(' ', 9 - strlen($level)),

+				'priority'      => $this->logLevels[$level],

+				'message'       => $message,

+				'context'       => json_encode($context),

+			);

+			$message = $this->options['logFormat'];

+			foreach ($parts as $part => $value) {

+				$message = str_replace('{'.$part.'}', $value, $message);

+			}

+

+		} else {

+			$message = "[{$this->getTimestamp()}] [{$level}] {$message}";

+		}

+

+		if ($this->options['appendContext'] && ! empty($context)) {

+			$message .= PHP_EOL.$this->indent($this->contextToString($context));

+		}

+

+		return $message.PHP_EOL;

+

+	}

+

+	/**

+	 * Gets the correctly formatted Date/Time for the log entry.

+	 *

+	 * PHP DateTime is dump, and you have to resort to trickery to get microseconds

+	 * to work correctly, so here it is.

+	 *

+	 * @return string

+	 */

+	private function getTimestamp()

+	{

+		$originalTime = microtime(true);

+		$micro = sprintf("%06d", ($originalTime - floor($originalTime)) * 1000000);

+		$date = new DateTime(date('Y-m-d H:i:s.'.$micro, (int)$originalTime));

+

+		return $date->format($this->options['dateFormat']);

+	}

+

+	/**

+	 * Takes the given context and coverts it to a string.

+	 *

+	 * @param  array $context The Context

+	 * @return string

+	 */

+	protected function contextToString($context)

+	{

+		$export = '';

+		foreach ($context as $key => $value) {

+			$export .= "{$key}: ";

+			$export .= preg_replace(array(

+				'/=>\s+([a-zA-Z])/im',

+				'/array\(\s+\)/im',

+				'/^  |\G  /m'

+			), array(

+				'=> $1',

+				'array()',

+				'    '

+			), str_replace('array (', 'array(', var_export($value, true)));

+			$export .= PHP_EOL;

+		}

+		return str_replace(array('\\\\', '\\\''), array('\\', '\''), rtrim($export));

+	}

+

+	/**

+	 * Indents the given string with the given indent.

+	 *

+	 * @param  string $string The string to indent

+	 * @param  string $indent What to use as the indent.

+	 * @return string

+	 */

+	protected function indent($string, $indent = '    ')

+	{

+		return $indent.str_replace("\n", "\n".$indent, $string);

+	}

 }