Skip to content

Commit

Permalink
Merge branch 'master' of github.com:madnest/madzipper
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakub Theimer committed Nov 20, 2021
2 parents 33076c2 + 2152aa0 commit 4387ad9
Show file tree
Hide file tree
Showing 4 changed files with 156 additions and 64 deletions.
164 changes: 128 additions & 36 deletions .php-cs-fixer.dist
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,135 @@
<?php

$finder = Symfony\Component\Finder\Finder::create()
->notPath('bootstrap/*')
->notPath('storage/*')
->notPath('resources/view/mail/*')
->in([
__DIR__ . '/src',
__DIR__ . '/tests',
])
$rules = [
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
'array_indentation' => true,
'binary_operator_spaces' => [
'default' => 'single_space',
],
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => true,
'blank_line_before_statement' => [
'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
],
'braces' => true,
'cast_spaces' => true,
'class_definition' => true,
'concat_space' => [
'spacing' => 'none',
],
'declare_equal_normalize' => true,
'elseif' => true,
'encoding' => true,
'full_opening_tag' => true,
'fully_qualified_strict_types' => true, // added by Shift
'function_declaration' => true,
'function_typehint_space' => true,
'heredoc_to_nowdoc' => true,
'include' => true,
'increment_style' => ['style' => 'post'],
'indentation_type' => true,
'linebreak_after_opening_tag' => true,
'line_ending' => true,
'magic_constant_casing' => true,
'method_argument_space' => true,
'native_function_casing' => true,
'no_alias_functions' => true,
'no_extra_blank_lines' => [
'tokens' => [
'extra',
'throw',
'use',
'use_trait',
],
],
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_closing_tag' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => [
'use' => 'echo',
],
'no_multiline_whitespace_around_double_arrow' => true,
'multiline_whitespace_before_semicolons' => [
'strategy' => 'no_multi_line',
],
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_after_function_name' => true,
'no_spaces_around_offset' => true,
'no_spaces_inside_parenthesis' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_trailing_whitespace' => true,
'no_trailing_whitespace_in_comment' => true,
'no_unneeded_control_parentheses' => true,
'no_unreachable_default_argument_value' => true,
'no_unused_imports' => true,
'no_useless_return' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'normalize_index_brace' => true,
'not_operator_with_successor_space' => true,
'object_operator_without_whitespace' => true,
'ordered_imports' => ['sort_algorithm' => 'alpha'],
'phpdoc_indent' => true,
'phpdoc_no_access' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'psr_autoloading' => true,
'self_accessor' => true,
'short_scalar_cast' => true,
'simplified_null_return' => true,
'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => true,
'single_import_per_statement' => true,
'single_line_after_imports' => true,
'single_line_comment_style' => [
'comment_types' => ['hash'],
],
'single_quote' => true,
'single_trait_insert_per_statement' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'visibility_required' => [
'elements' => ['method', 'property'],
],
'whitespace_after_comma_in_array' => true,
];

$finder = PhpCsFixer\Finder::create()
->notPath('bootstrap')
->notPath('storage')
->notPath('vendor')
->in(getcwd())
->name('*.php')
->notName('*.blade.php')
->notName('index.php')
->notName('server.php')
->ignoreDotFiles(true)
->ignoreVCS(true);

return PhpCsFixer\Config::create()
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
'ordered_imports' => ['sortAlgorithm' => 'alpha'],
'no_unused_imports' => true,
'not_operator_with_successor_space' => true,
'trailing_comma_in_multiline_array' => true,
'phpdoc_scalar' => true,
'unary_operator_spaces' => true,
'binary_operator_spaces' => true,
'blank_line_before_statement' => [
'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
],
'phpdoc_single_line_var_spacing' => true,
'phpdoc_var_without_name' => true,
'class_attributes_separation' => [
'elements' => [
'method',
],
],
'method_argument_space' => [
'on_multiline' => 'ensure_fully_multiline',
'keep_multiple_spaces_after_comma' => true,
],
'single_trait_insert_per_statement' => true,
])
->setFinder($finder);
$config = new PhpCsFixer\Config();

return $config
->setFinder($finder)
->setRules($rules)
->setRiskyAllowed(true)
->setUsingCache(true);
26 changes: 13 additions & 13 deletions src/Madnest/Madzipper/Repositories/RepositoryInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
namespace Madnest\Madzipper\Repositories;

/**
* RepositoryInterface that needs to be implemented by every Repository
* RepositoryInterface that needs to be implemented by every Repository.
*
* Class RepositoryInterface
*/
interface RepositoryInterface
{
/**
* Construct with a given path
* Construct with a given path.
*
* @param $filePath
* @param bool $new
Expand All @@ -19,37 +19,37 @@ interface RepositoryInterface
public function __construct($filePath, $new = false, $archiveImplementation = null);

/**
* Add a file to the opened Archive
* Add a file to the opened Archive.
*
* @param $pathToFile
* @param $pathInArchive
*/
public function addFile($pathToFile, $pathInArchive);

/**
* Add a file to the opened Archive using its contents
* Add a file to the opened Archive using its contents.
*
* @param $name
* @param $content
*/
public function addFromString($name, $content);

/**
* Add an empty directory
* Add an empty directory.
*
* @param $dirName
*/
public function addEmptyDir($dirName);

/**
* Remove a file permanently from the Archive
* Remove a file permanently from the Archive.
*
* @param $pathInArchive
*/
public function removeFile($pathInArchive);

/**
* Get the content of a file
* Get the content of a file.
*
* @param $pathInArchive
*
Expand All @@ -58,7 +58,7 @@ public function removeFile($pathInArchive);
public function getFileContent($pathInArchive);

/**
* Get the stream of a file
* Get the stream of a file.
*
* @param $pathInArchive
*
Expand All @@ -68,14 +68,14 @@ public function getFileStream($pathInArchive);

/**
* Will loop over every item in the archive and will execute the callback on them
* Will provide the filename for every item
* Will provide the filename for every item.
*
* @param $callback
*/
public function each($callback);

/**
* Checks whether the file is in the archive
* Checks whether the file is in the archive.
*
* @param $fileInArchive
*
Expand All @@ -84,7 +84,7 @@ public function each($callback);
public function fileExists($fileInArchive);

/**
* Sets the password to be used for decompressing
* Sets the password to be used for decompressing.
*
* @param $password
*
Expand All @@ -93,14 +93,14 @@ public function fileExists($fileInArchive);
public function usePassword($password);

/**
* Returns the status of the archive as a string
* Returns the status of the archive as a string.
*
* @return string
*/
public function getStatus();

/**
* Closes the archive and saves it
* Closes the archive and saves it.
*/
public function close();
}
Loading

0 comments on commit 4387ad9

Please sign in to comment.