Conditions | 16 |
Paths | 84 |
Total Lines | 105 |
Code Lines | 70 |
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 |
||
98 | public function execute() { |
||
99 | $doDelete = $this->hasOption( 'delete' ); |
||
100 | $doDeleteTalk = $this->hasOption( 'delete-talk' ); |
||
101 | $langCode = $this->getOption( 'lang-code' ); |
||
102 | |||
103 | $messageInfo = [ |
||
104 | 'relevantPages' => 0, |
||
105 | 'equalPages' => 0, |
||
106 | 'equalPagesTalks' => 0, |
||
107 | 'results' => [], |
||
108 | ]; |
||
109 | |||
110 | $this->output( 'Checking for pages with default message...' ); |
||
111 | |||
112 | // Load message information |
||
113 | if ( $langCode ) { |
||
114 | $langCodes = Language::fetchLanguageNames( null, 'mwfile' ); |
||
115 | if ( $langCode === '*' ) { |
||
116 | // All valid lang-code subpages in NS_MEDIAWIKI that |
||
117 | // override the messsages in that language |
||
118 | foreach ( $langCodes as $key => $value ) { |
||
119 | $this->fetchMessageInfo( $key, $messageInfo ); |
||
120 | } |
||
121 | // Lastly, the base pages in NS_MEDIAWIKI that override |
||
122 | // messages in content language |
||
123 | $this->fetchMessageInfo( false, $messageInfo ); |
||
124 | } else { |
||
125 | if ( !isset( $langCodes[$langCode] ) ) { |
||
126 | $this->error( 'Invalid language code: ' . $langCode, 1 ); |
||
127 | } |
||
128 | $this->fetchMessageInfo( $langCode, $messageInfo ); |
||
129 | } |
||
130 | } else { |
||
131 | $this->fetchMessageInfo( false, $messageInfo ); |
||
132 | } |
||
133 | |||
134 | if ( $messageInfo['equalPages'] === 0 ) { |
||
135 | // No more equal messages left |
||
136 | $this->output( "\ndone.\n" ); |
||
137 | |||
138 | return; |
||
139 | } |
||
140 | |||
141 | $this->output( "\n{$messageInfo['relevantPages']} pages in the MediaWiki namespace " |
||
142 | . "override messages." ); |
||
143 | $this->output( "\n{$messageInfo['equalPages']} pages are equal to the default message " |
||
144 | . "(+ {$messageInfo['equalPagesTalks']} talk pages).\n" ); |
||
145 | |||
146 | if ( !$doDelete ) { |
||
147 | $list = ''; |
||
148 | foreach ( $messageInfo['results'] as $result ) { |
||
149 | $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] ); |
||
150 | $list .= "* [[$title]]\n"; |
||
151 | if ( $result['hasTalk'] ) { |
||
152 | $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] ); |
||
153 | $list .= "* [[$title]]\n"; |
||
154 | } |
||
155 | } |
||
156 | $this->output( "\nList:\n$list\nRun the script again with --delete to delete these pages" ); |
||
157 | if ( $messageInfo['equalPagesTalks'] !== 0 ) { |
||
158 | $this->output( " (include --delete-talk to also delete the talk pages)" ); |
||
159 | } |
||
160 | $this->output( "\n" ); |
||
161 | |||
162 | return; |
||
163 | } |
||
164 | |||
165 | $user = User::newSystemUser( 'MediaWiki default', [ 'steal' => true ] ); |
||
166 | if ( !$user ) { |
||
167 | $this->error( "Invalid username", true ); |
||
168 | } |
||
169 | global $wgUser; |
||
170 | $wgUser = $user; |
||
171 | |||
172 | // Hide deletions from RecentChanges |
||
173 | $user->addGroup( 'bot' ); |
||
174 | |||
175 | // Handle deletion |
||
176 | $this->output( "\n...deleting equal messages (this may take a long time!)..." ); |
||
177 | $dbw = $this->getDB( DB_MASTER ); |
||
178 | foreach ( $messageInfo['results'] as $result ) { |
||
179 | wfWaitForSlaves(); |
||
180 | $dbw->ping(); |
||
181 | $title = Title::makeTitle( NS_MEDIAWIKI, $result['title'] ); |
||
182 | $this->output( "\n* [[$title]]" ); |
||
183 | $page = WikiPage::factory( $title ); |
||
184 | $error = ''; // Passed by ref |
||
185 | $success = $page->doDeleteArticle( 'No longer required', false, 0, true, $error, $user ); |
||
186 | if ( !$success ) { |
||
187 | $this->output( " (Failed!)" ); |
||
188 | } |
||
189 | if ( $result['hasTalk'] && $doDeleteTalk ) { |
||
190 | $title = Title::makeTitle( NS_MEDIAWIKI_TALK, $result['title'] ); |
||
191 | $this->output( "\n* [[$title]]" ); |
||
192 | $page = WikiPage::factory( $title ); |
||
193 | $error = ''; // Passed by ref |
||
194 | $success = $page->doDeleteArticle( 'Orphaned talk page of no longer required message', |
||
195 | false, 0, true, $error, $user ); |
||
196 | if ( !$success ) { |
||
197 | $this->output( " (Failed!)" ); |
||
198 | } |
||
199 | } |
||
200 | } |
||
201 | $this->output( "\n\ndone!\n" ); |
||
202 | } |
||
203 | } |
||
207 |
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.