wikimedia /
mediawiki
| Conditions | 16 |
| Paths | 1080 |
| Total Lines | 61 |
| Code Lines | 42 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 13 | public function execute() { |
||
| 14 | if ( !class_exists( Validator::class ) ) { |
||
| 15 | $this->error( 'The JsonSchema library cannot be found, please install it through composer.', 1 ); |
||
| 16 | } elseif ( !class_exists( SpdxLicenses::class ) ) { |
||
| 17 | $this->error( |
||
| 18 | 'The spdx-licenses library cannot be found, please install it through composer.', 1 |
||
| 19 | ); |
||
| 20 | } |
||
| 21 | |||
| 22 | $path = $this->getArg( 0 ); |
||
| 23 | $data = json_decode( file_get_contents( $path ) ); |
||
| 24 | if ( !is_object( $data ) ) { |
||
| 25 | $this->error( "$path is not a valid JSON file.", 1 ); |
||
| 26 | } |
||
| 27 | if ( !isset( $data->manifest_version ) ) { |
||
| 28 | $this->output( "Warning: No manifest_version set, assuming 1.\n" ); |
||
| 29 | // For backwards-compatability assume 1 |
||
| 30 | $data->manifest_version = 1; |
||
| 31 | } |
||
| 32 | $version = $data->manifest_version; |
||
| 33 | if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) { |
||
| 34 | $schemaPath = dirname( __DIR__ ) . "/docs/extension.schema.v$version.json"; |
||
| 35 | } else { |
||
| 36 | $schemaPath = dirname( __DIR__ ) . '/docs/extension.schema.json'; |
||
| 37 | } |
||
| 38 | |||
| 39 | if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION |
||
| 40 | || $version > ExtensionRegistry::MANIFEST_VERSION |
||
| 41 | ) { |
||
| 42 | $this->error( "Error: $path is using a non-supported schema version, it should use " |
||
| 43 | . ExtensionRegistry::MANIFEST_VERSION, 1 ); |
||
| 44 | } elseif ( $version < ExtensionRegistry::MANIFEST_VERSION ) { |
||
| 45 | $this->output( "Warning: $path is using a deprecated schema, and should be updated to " |
||
| 46 | . ExtensionRegistry::MANIFEST_VERSION . "\n" ); |
||
| 47 | } |
||
| 48 | |||
| 49 | $licenseError = false; |
||
| 50 | // Check if it's a string, if not, schema validation will display an error |
||
| 51 | if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) { |
||
| 52 | $licenses = new SpdxLicenses(); |
||
| 53 | $valid = $licenses->validate( $data->{'license-name'} ); |
||
| 54 | if ( !$valid ) { |
||
| 55 | $licenseError = '[license-name] Invalid SPDX license identifier, ' |
||
| 56 | . 'see <https://spdx.org/licenses/>'; |
||
| 57 | } |
||
| 58 | } |
||
| 59 | |||
| 60 | $validator = new Validator; |
||
| 61 | $validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] ); |
||
| 62 | if ( $validator->isValid() && !$licenseError ) { |
||
| 63 | $this->output( "$path validates against the version $version schema!\n" ); |
||
| 64 | } else { |
||
| 65 | foreach ( $validator->getErrors() as $error ) { |
||
| 66 | $this->output( "[{$error['property']}] {$error['message']}\n" ); |
||
| 67 | } |
||
| 68 | if ( $licenseError ) { |
||
| 69 | $this->output( "$licenseError\n" ); |
||
| 70 | } |
||
| 71 | $this->error( "$path does not validate.", 1 ); |
||
| 72 | } |
||
| 73 | } |
||
| 74 | } |
||
| 78 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.