Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fix #9

Merged
merged 24 commits into from
Oct 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
vendor/
ansible/
composer.lock
phpunit.xml
/report/
/.idea
/.php_cs.cache
2 changes: 1 addition & 1 deletion .php_cs.cache
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"php":"7.1.19","version":"2.13.0:v2.13.0#7136aa4e0c5f912e8af82383775460d906168a10","rules":{"array_syntax":{"syntax":"short"},"binary_operator_spaces":true,"blank_line_after_namespace":true,"blank_line_after_opening_tag":true,"blank_line_before_return":true,"braces":true,"cast_spaces":true,"class_definition":true,"combine_consecutive_unsets":true,"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"elseif":true,"encoding":true,"full_opening_tag":true,"function_declaration":true,"function_typehint_space":true,"hash_to_slash_comment":true,"include":true,"line_ending":true,"linebreak_after_opening_tag":true,"lowercase_cast":true,"lowercase_constants":true,"lowercase_keywords":true,"method_argument_space":true,"method_separation":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_closing_tag":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_consecutive_blank_lines":["break","continue","extra","return","throw","use","useTrait","curly_brace_block","parenthesis_brace_block","square_brace_block"],"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_multiline_whitespace_before_semicolons":true,"no_short_bool_cast":true,"no_short_echo_tag":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_after_function_name":true,"no_spaces_around_offset":["outside","inside"],"no_spaces_inside_parenthesis":true,"no_trailing_comma_in_list_call":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"no_unneeded_control_parentheses":["break","clone","continue","echo_print","return","switch_case","yield"],"no_useless_else":true,"no_useless_return":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"ordered_imports":true,"php_unit_fqcn_annotation":true,"phpdoc_align":true,"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_package":true,"phpdoc_order":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"pre_increment":true,"return_type_declaration":{"space_before":"one"},"self_accessor":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_at_eof":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":["property","const"],"single_import_per_statement":true,"single_line_after_imports":true,"single_quote":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_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"visibility_required":["property","method"],"whitespace_after_comma_in_array":true},"hashes":{"test\/Platform\/Webservices\/PlatformConfigTest.php":1297814751,"test\/Platform\/AbstractConfigTest.php":3581377769,"test\/Protocol\/Soap\/Config\/ConfigFactoryTest.php":2507575749,"test\/Protocol\/Soap\/Config\/Platform\/Webservices\/ConverterTest.php":364419612,"test\/Protocol\/Soap\/Config\/Platform\/Webservices\/ConfigTest.php":3892438805,"test\/Protocol\/Soap\/Client\/SoapSettingsTest.php":1462626334,"test\/Protocol\/Soap\/Client\/SoapClientFactoryTest.php":2646719899,"test\/Protocol\/Soap\/Client\/SoapConfigTest.php":803846229,"test\/Protocol\/Soap\/Client\/SoapClientTest.php":1085502639,"test\/Factories\/SoapFault.php":2331590605,"test\/Factories\/SoapConfig.php":2341532477,"test\/Factories\/Endpoint.php":3822911515,"test\/Factories\/SoapSettings.php":1092224958,"test\/Connector\/ConnectorFactoryTest.php":2909281756,"test\/Connector\/ProtocolAdapter\/SoapAdapterTest.php":4271768068,"src\/Platform\/Webservices\/Connector.php":927062776,"src\/Platform\/Webservices\/PlatformConfig.php":584540132,"src\/Platform\/AbstractConfig.php":2481503531,"src\/Platform\/PlatformConfigInterface.php":3598364373,"src\/Protocol\/Soap\/Config\/Platform\/Webservices\/Config.php":1962477452,"src\/Protocol\/Soap\/Config\/Platform\/Webservices\/Converter.php":1258500524,"src\/Protocol\/Soap\/Config\/ConfigFactory.php":649097879,"src\/Protocol\/Soap\/Helper\/GuzzleClientFactory.php":1594240659,"src\/Protocol\/Soap\/Exception\/ConverterInterface.php":355543651,"src\/Protocol\/Soap\/Client\/SoapConfig.php":4294472648,"src\/Protocol\/Soap\/Client\/SoapFactory.php":137363353,"src\/Protocol\/Soap\/Client\/SoapSettings.php":3779605265,"src\/Protocol\/Soap\/Client\/SoapClient.php":2110305753,"src\/Connector\/AbstractConnector.php":927974546,"src\/Connector\/ProtocolAdapter\/AdapterInterface.php":1132456117,"src\/Connector\/ProtocolAdapter\/SoapAdapter.php":329348456,"src\/Connector\/ProtocolAdapter\/AbstractAdapter.php":4238807776,"src\/Connector\/ConnectorFactory.php":1102109742,"src\/Connector\/ConnectorInterface.php":1257789075,"src\/Connector\/Client\/ClientFactoryInterface.php":2944850943,"src\/Connector\/Client\/ClientInterface.php":2646377133,"src\/Connector\/Client\/AbstractClientFactory.php":611261920}}
{"php":"7.3.11","version":"2.15.3:v2.15.3#705490b0f282f21017d73561e9498d2b622ee34c","indent":" ","lineEnding":"\n","rules":{"array_syntax":{"syntax":"short"},"binary_operator_spaces":true,"blank_line_after_namespace":true,"blank_line_after_opening_tag":true,"blank_line_before_return":true,"braces":true,"cast_spaces":true,"class_definition":true,"combine_consecutive_unsets":true,"concat_space":{"spacing":"one"},"declare_equal_normalize":true,"elseif":true,"encoding":true,"full_opening_tag":true,"function_declaration":true,"function_typehint_space":true,"hash_to_slash_comment":true,"include":true,"line_ending":true,"linebreak_after_opening_tag":true,"lowercase_cast":true,"lowercase_constants":true,"lowercase_keywords":true,"method_argument_space":true,"method_separation":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_closing_tag":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_consecutive_blank_lines":["break","continue","extra","return","throw","use","useTrait","curly_brace_block","parenthesis_brace_block","square_brace_block"],"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_multiline_whitespace_before_semicolons":true,"no_short_bool_cast":true,"no_short_echo_tag":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_after_function_name":true,"no_spaces_around_offset":["outside","inside"],"no_spaces_inside_parenthesis":true,"no_trailing_comma_in_list_call":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"no_unneeded_control_parentheses":["break","clone","continue","echo_print","return","switch_case","yield"],"no_useless_else":true,"no_useless_return":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"ordered_imports":true,"php_unit_fqcn_annotation":true,"phpdoc_align":true,"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_package":true,"phpdoc_order":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"pre_increment":true,"return_type_declaration":{"space_before":"one"},"self_accessor":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_at_eof":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":["property","const"],"single_import_per_statement":true,"single_line_after_imports":true,"single_quote":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_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"visibility_required":["property","method"],"whitespace_after_comma_in_array":true},"hashes":{"src\/Platform\/Webservices\/Connector.php":1646788085,"src\/Platform\/Webservices\/PlatformConfig.php":584540132,"src\/Platform\/AbstractConfig.php":2481503531,"src\/Platform\/PlatformConfigInterface.php":3598364373,"src\/Protocol\/Soap\/Config\/Platform\/Webservices\/Config.php":1962477452,"src\/Protocol\/Soap\/Config\/Platform\/Webservices\/Converter.php":1258500524,"src\/Protocol\/Soap\/Config\/ConfigFactory.php":649097879,"src\/Protocol\/Soap\/Helper\/GuzzleClientFactory.php":1594240659,"src\/Protocol\/Soap\/Exception\/ConverterInterface.php":355543651,"src\/Protocol\/Soap\/Client\/SoapConfig.php":4294472648,"src\/Protocol\/Soap\/Client\/SoapFactory.php":137363353,"src\/Protocol\/Soap\/Client\/SoapSettings.php":3779605265,"src\/Protocol\/Soap\/Client\/SoapClient.php":1161450579,"src\/Connector\/AbstractConnector.php":927974546,"src\/Connector\/ProtocolAdapter\/AdapterInterface.php":1132456117,"src\/Connector\/ProtocolAdapter\/SoapAdapter.php":329348456,"src\/Connector\/ProtocolAdapter\/AbstractAdapter.php":4238807776,"src\/Connector\/ConnectorFactory.php":1102109742,"src\/Connector\/ConnectorInterface.php":1257789075,"src\/Connector\/Client\/ClientFactoryInterface.php":2944850943,"src\/Connector\/Client\/ClientInterface.php":2646377133,"src\/Connector\/Client\/AbstractClientFactory.php":611261920,"test\/Platform\/Webservices\/PlatformConfigTest.php":3464410096,"test\/Platform\/AbstractConfigTest.php":2308254375,"test\/Protocol\/Soap\/Config\/ConfigFactoryTest.php":1505716610,"test\/Protocol\/Soap\/Config\/Platform\/Webservices\/ConverterTest.php":3888177838,"test\/Protocol\/Soap\/Config\/Platform\/Webservices\/ConfigTest.php":1277646666,"test\/Protocol\/Soap\/Client\/SoapSettingsTest.php":2778408646,"test\/Protocol\/Soap\/Client\/SoapClientFactoryTest.php":3194474694,"test\/Protocol\/Soap\/Client\/SoapConfigTest.php":3933928487,"test\/Protocol\/Soap\/Client\/SoapClientTest.php":1897905487,"test\/Factories\/SoapFault.php":2331590605,"test\/Factories\/SoapConfig.php":3038946238,"test\/Factories\/Endpoint.php":3144424824,"test\/Factories\/SoapSettings.php":4254558957,"test\/Connector\/ConnectorFactoryTest.php":1952522840,"test\/Connector\/ProtocolAdapter\/SoapAdapterTest.php":4027638242}}
198 changes: 198 additions & 0 deletions .php_cs.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
<?php

$finder = PhpCsFixer\Finder::create()
->exclude('vendor')
->in(__DIR__)
;

return PhpCsFixer\Config::create()
->setRiskyAllowed(false)
->setFinder($finder)
->setRules(
[
'array_syntax' => ['syntax' => 'short'],
'binary_operator_spaces' => true,
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => true,
'blank_line_before_return' => true,
'braces' => true,
'cast_spaces' => true,
'class_definition' => true,
'class_keyword_remove' => false,
'combine_consecutive_unsets' => true,
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => true,
'declare_strict_types' => false, // risky
'dir_constant' => false, // risky
'elseif' => true,
'encoding' => true,
'ereg_to_preg' => false,
'full_opening_tag' => true,
'function_declaration' => true,
'function_typehint_space' => true,
'general_phpdoc_annotation_remove' => false,
'hash_to_slash_comment' => true,
//'header_comment' => ['header' => 'header'],
'heredoc_to_nowdoc' => false,
'include' => true,
//'indentation_type' => [],
'line_ending' => true,
'linebreak_after_opening_tag' => true,
'lowercase_cast' => true,
'lowercase_constants' => true,
'lowercase_keywords' => true,
'mb_str_functions' => false,
'method_argument_space' => true,
'method_separation' => true,
'modernize_types_casting' => false, // risky
'native_function_casing' => true,
'new_with_braces' => true,
'no_alias_functions' => false,
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_blank_lines_before_namespace' => false,
'no_closing_tag' => true,
'no_empty_comment' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_consecutive_blank_lines' => [
'break',
'continue',
'extra',
'return',
'throw',
'use',
'useTrait',
'curly_brace_block',
'parenthesis_brace_block',
'square_brace_block',
],
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => ['use' => 'echo'],
'no_multiline_whitespace_around_double_arrow' => true,
'no_multiline_whitespace_before_semicolons' => true,
'no_php4_constructor' => false, //risky
'no_short_bool_cast' => true,
'no_short_echo_tag' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_after_function_name' => true,
'no_spaces_around_offset' => ['outside', 'inside'],
'no_spaces_inside_parenthesis' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => false,
'no_trailing_whitespace' => true,
'no_trailing_whitespace_in_comment' => true,
'no_unneeded_control_parentheses' => [
'break',
'clone',
'continue',
'echo_print',
'return',
'switch_case',
'yield',
],
'no_unreachable_default_argument_value' => false, //risky
'no_unused_imports' => false,
'no_useless_else' => 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_space' => false,
'not_operator_with_successor_space' => false,
'object_operator_without_whitespace' => false,
/*
'ordered_class_elements' => [
'use_trait',
'public',
'protected',
'private',
'constant',
'constant_public',
'constant_protected',
'constant_private',
//'property',
'property_static',
'property_public',
'property_protected',
'property_private',
'property_public_static',
'property_protected_static',
'property_private_static',
'construct',
//'method',
'method_static',
'method_public',
'method_protected',
'method_private',
'method_public_static',
'method_protected_static',
'method_private_static',
'destruct',
'magic',
'phpunit',
],
*/
'ordered_imports' => true,
'php_unit_construct' => false, // risky
'php_unit_dedicate_assert' => false, // risky
'php_unit_fqcn_annotation' => true,
'php_unit_strict' => false, // risky
'phpdoc_add_missing_param_annotation' => [],
'phpdoc_align' => true,
'phpdoc_annotation_without_dot' => true,
'phpdoc_indent' => true,
'phpdoc_inline_tag' => true,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => false,
'phpdoc_no_empty_return' => false,
'phpdoc_no_package' => true,
'phpdoc_order' => true, // ?
'phpdoc_scalar' => true,
'phpdoc_separation' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => false,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'pow_to_exponentiation' => false, // risky
'pre_increment' => true,
'protected_to_private' => false,
'psr0' => false,// risky
'psr4' => false,// risky
'random_api_migration' => false, // risky
'return_type_declaration' => [
'space_before' => 'one',
],
'self_accessor' => true,
'semicolon_after_instruction' => true,
'short_scalar_cast' => true,
'silenced_deprecation_error' => false, // risky
'simplified_null_return' => false, // risky
'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => ['property', 'const'],
'single_import_per_statement' => true,
'single_line_after_imports' => true,
'single_quote' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'strict_comparison' => false, // risky
'strict_param' => false, // risky
'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline_array' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'visibility_required' => [
'property',
'method',
//'const'
],
'whitespace_after_comma_in_array' => true,
]
)
;
Loading