<?xml version="1.0"?>
<ruleset name="DokuWiki Coding Standard Standard" namespace="DokuWiki\CS\Standard">
    <description>Coding Standard used for DokuWiki</description>

    <!-- default config -->
    <arg name="colors"/>
    <arg value="sp"/>
    <arg name="extensions" value="php"/>

    <ini name="memory_limit" value="-1"/>

    <!-- where to look -->
    <file>../inc</file>
    <file>../lib</file>
    <file>../bin</file>
    <file>../doku.php</file>
    <file>../index.php</file>
    <file>../feed.php</file>
    <file>../install.php</file>

    <!-- skip these completely -->
    <exclude-pattern>*/lang/*/lang.php</exclude-pattern>
    <exclude-pattern>*/lang/*/settings.php</exclude-pattern>
    <exclude-pattern>*/_test/*</exclude-pattern>

    <!-- 3rd party libs, these should be moved to composer some day -->
    <exclude-pattern>*/inc/DifferenceEngine.php</exclude-pattern>
    <exclude-pattern>*/inc/IXR_Library.php</exclude-pattern>
    <exclude-pattern>*/inc/JSON.php</exclude-pattern>
    <exclude-pattern>*/inc/JpegMeta.php</exclude-pattern>
    <exclude-pattern>*/lib/plugins/authad/adLDAP</exclude-pattern>

    <!-- deprecated files to be removed soon -->
    <exclude-pattern>*/inc/cli.php</exclude-pattern>
    <exclude-pattern>*/inc/parser/*</exclude-pattern>

    <!-- rules on top of PSR-2 -->
    <rule ref="PSR12">
        <!-- the following rule is not in PSR-2 and breaks the guardian pattern -->
        <exclude name="Generic.ControlStructures.InlineControlStructure.NotAllowed"/>

        <!-- we have lots of legacy classes without name spaces -->
        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>

        <!-- Rules with automatic fixes that we want to adhere to, but currently don't -->
        <exclude name="Generic.Formatting.DisallowMultipleStatements.SameLine"/>
        <exclude name="Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterComma"/>
        <exclude name="Generic.Functions.FunctionCallArgumentSpacing.SpaceBeforeComma"/>
        <exclude name="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma"/>
        <exclude name="Generic.PHP.LowerCaseKeyword.Found"/>
        <exclude name="Generic.PHP.LowerCaseConstant.Found"/>
        <exclude name="Generic.WhiteSpace.ScopeIndent.IncorrectExact"/>
        <exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect"/>
        <exclude name="Generic.WhiteSpace.IncrementDecrementSpacing.SpaceAfterDecrement"/>
        <exclude name="Generic.WhiteSpace.IncrementDecrementSpacing.SpaceAfterIncrement"/>

        <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseParenthesis"/>
        <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterKeyword"/>
        <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseBrace"/>
        <exclude name="Squiz.ControlStructures.ControlSignature.NewlineAfterOpenBrace"/>
        <exclude name="Squiz.ControlStructures.ForEachLoopDeclaration.NoSpaceBeforeArrow"/>
        <exclude name="Squiz.ControlStructures.ForEachLoopDeclaration.NoSpaceAfterArrow"/>
        <exclude name="Squiz.ControlStructures.ForEachLoopDeclaration.SpacingBeforeAs"/>
        <exclude name="Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterSecond"/>
        <exclude name="Squiz.ControlStructures.ForLoopDeclaration.NoSpaceAfterSecond"/>
        <exclude name="Squiz.ControlStructures.ForLoopDeclaration.NoSpaceAfterFirst"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.NoSpaceBeforeArg"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpaceAfterEquals"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterReference"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingBeforeClose"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpaceBeforeEquals"/>
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine"/>
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.NewlineBeforeOpenBrace"/>
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.CloseBracketLine"/>
        <exclude name="Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpen"/>
        <exclude name="Squiz.WhiteSpace.ControlStructureSpacing.SpacingBeforeClose"/>
        <exclude name="Squiz.WhiteSpace.ScopeClosingBrace.ContentBefore"/>
        <exclude name="Squiz.WhiteSpace.ScopeClosingBrace.Indent"/>
        <exclude name="Squiz.WhiteSpace.SuperfluousWhitespace.EndLine"/>

        <exclude name="PSR2.Classes.ClassDeclaration.CloseBraceAfterBody"/>
        <exclude name="PSR2.Classes.ClassDeclaration.OpenBraceNewLine"/>
        <exclude name="PSR2.Classes.PropertyDeclaration.StaticBeforeVisibility"/>
        <exclude name="PSR2.ControlStructures.ControlStructureSpacing.SpacingAfterOpenBrace"/>
        <exclude name="PSR2.ControlStructures.ControlStructureSpacing.SpaceBeforeCloseBrace"/>
        <exclude name="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed"/>
        <exclude name="PSR2.ControlStructures.SwitchDeclaration.BreakIndent"/>
        <exclude name="PSR2.ControlStructures.SwitchDeclaration.BreakNotNewLine"/>
        <exclude name="PSR2.ControlStructures.SwitchDeclaration.BodyOnNextLineCASE"/>
        <exclude name="PSR2.ControlStructures.SwitchDeclaration.SpaceBeforeColonDEFAULT"/>
        <exclude name="PSR2.ControlStructures.SwitchDeclaration.SpaceBeforeColonCASE"/>
        <exclude name="PSR2.Files.EndFileNewline.TooMany"/>
        <exclude name="PSR2.Files.EndFileNewline.NoneFound"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.Indent"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.EmptyLine"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.ContentAfterOpenBracket"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.SpaceBeforeOpenBracket"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.CloseBracketLine"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.SpaceBeforeCloseBracket"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.SpaceAfterOpenBracket"/>
        <exclude name="PSR2.Methods.FunctionCallSignature.MultipleArguments"/>
        <exclude name="PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose"/>
        <exclude name="PSR2.Methods.MethodDeclaration.StaticBeforeVisibility"/>
        <exclude name="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter"/>
        <exclude name="PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse"/>

        <exclude name="PSR12.Classes.ClassInstantiation.MissingParentheses"/>
        <exclude name="PSR12.ControlStructures.BooleanOperatorPlacement.FoundMixed"/>
        <exclude name="PSR12.ControlStructures.ControlStructureSpacing.FirstExpressionLine"/>
        <exclude name="PSR12.ControlStructures.ControlStructureSpacing.CloseParenthesisLine"/>
        <exclude name="PSR12.ControlStructures.ControlStructureSpacing.LineIndent"/>
        <exclude name="PSR12.ControlStructures.ControlStructureSpacing.SpacingAfterOpenBrace"/>
        <exclude name="PSR12.ControlStructures.ControlStructureSpacing.SpaceBeforeCloseBrace"/>
        <exclude name="PSR12.Files.FileHeader.SpacingAfterBlock"/>
        <exclude name="PSR12.Operators.OperatorSpacing.NoSpaceBefore"/>
        <exclude name="PSR12.Operators.OperatorSpacing.NoSpaceAfter"/>

        <exclude name="PSR12.Properties.ConstantVisibility.NotFound"/>
    </rule>

    <!-- disable some rules for certain paths, for legacy support -->
    <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
        <exclude-pattern>*/inc/Plugin.php</exclude-pattern>
        <exclude-pattern>*/inc/PluginInterface.php</exclude-pattern>
        <exclude-pattern>*/inc/PluginTrait.php</exclude-pattern>

        <exclude-pattern>*/lib/plugins/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/action.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/action/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/admin.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/admin/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/auth.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/auth/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/cli.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/cli/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/helper.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/helper/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/remote.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/remote/*.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/syntax.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/syntax/*.php</exclude-pattern>
    </rule>

    <!-- underscore skips exposing public methods to remote api -->
    <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
        <exclude-pattern>*/inc/Extension/RemotePlugin.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/remote.php</exclude-pattern>
        <exclude-pattern>*/lib/plugins/*/remote/*.php</exclude-pattern>
    </rule>

    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
        <exclude-pattern>*/inc/Extension/PluginInterface.php</exclude-pattern>
        <exclude-pattern>*/inc/Extension/PluginTrait.php</exclude-pattern>
    </rule>

    <!-- for now we mix declarations and execution here (mostly for defines) -->
    <rule ref="PSR1.Files.SideEffects">
        <exclude-pattern>*/index.php</exclude-pattern>
        <exclude-pattern>*/inc/parserutils.php</exclude-pattern>
        <exclude-pattern>*/inc/mail.php</exclude-pattern>
        <exclude-pattern>*/inc/init.php</exclude-pattern>
        <exclude-pattern>*/inc/farm.php</exclude-pattern>
        <exclude-pattern>*/inc/fulltext.php</exclude-pattern>
        <exclude-pattern>*/inc/pluginutils.php</exclude-pattern>
        <exclude-pattern>*/inc/indexer.php</exclude-pattern>
        <exclude-pattern>*/inc/Mailer.class.php</exclude-pattern>
        <exclude-pattern>*/doku.php</exclude-pattern>
        <exclude-pattern>*/install.php</exclude-pattern>
        <exclude-pattern>*/inc/utf8.php</exclude-pattern>
        <exclude-pattern>*/feed.php</exclude-pattern>
        <exclude-pattern>*/inc/load.php</exclude-pattern>
        <exclude-pattern>*/bin/*.php</exclude-pattern>
        <exclude-pattern>*/lib/exe/*.php</exclude-pattern>
    </rule>

</ruleset>
