Conditions | 29 |
Paths | 14112 |
Total Lines | 154 |
Code Lines | 112 |
Lines | 5 |
Ratio | 3.25 % |
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 |
||
49 | public function execute() { |
||
50 | $userName = $this->getOption( 'user', false ); |
||
51 | $summary = $this->getOption( 'summary', 'Imported from text file' ); |
||
52 | $useTimestamp = $this->hasOption( 'use-timestamp' ); |
||
53 | $rc = $this->hasOption( 'rc' ); |
||
54 | $bot = $this->hasOption( 'bot' ); |
||
55 | $overwrite = $this->hasOption( 'overwrite' ); |
||
56 | $prefix = $this->getOption( 'prefix', '' ); |
||
57 | |||
58 | // Get all the arguments. A loop is required since Maintenance doesn't |
||
59 | // support an arbitrary number of arguments. |
||
60 | $files = []; |
||
61 | $i = 0; |
||
62 | while ( $arg = $this->getArg( $i++ ) ) { |
||
63 | if ( file_exists( $arg ) ) { |
||
64 | $files[$arg] = file_get_contents( $arg ); |
||
65 | } else { |
||
66 | // use glob to support the Windows shell, which doesn't automatically |
||
67 | // expand wildcards |
||
68 | $found = false; |
||
69 | foreach ( glob( $arg ) as $filename ) { |
||
70 | $found = true; |
||
71 | $files[$filename] = file_get_contents( $filename ); |
||
72 | } |
||
73 | if ( !$found ) { |
||
74 | $this->error( "Fatal error: The file '$arg' does not exist!", 1 ); |
||
75 | } |
||
76 | } |
||
77 | }; |
||
78 | |||
79 | $count = count( $files ); |
||
80 | $this->output( "Importing $count pages...\n" ); |
||
81 | |||
82 | View Code Duplication | if ( $userName === false ) { |
|
83 | $user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] ); |
||
84 | } else { |
||
85 | $user = User::newFromName( $userName ); |
||
86 | } |
||
87 | |||
88 | if ( !$user ) { |
||
89 | $this->error( "Invalid username\n", true ); |
||
90 | } |
||
91 | if ( $user->isAnon() ) { |
||
92 | $user->addToDatabase(); |
||
93 | } |
||
94 | |||
95 | $exit = 0; |
||
96 | |||
97 | $successCount = 0; |
||
98 | $failCount = 0; |
||
99 | $skipCount = 0; |
||
100 | |||
101 | foreach ( $files as $file => $text ) { |
||
102 | $pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME ); |
||
103 | $timestamp = $useTimestamp ? wfTimestamp( TS_UNIX, filemtime( $file ) ) : wfTimestampNow(); |
||
104 | |||
105 | $title = Title::newFromText( $pageName ); |
||
106 | // Have to check for # manually, since it gets interpreted as a fragment |
||
107 | if ( !$title || $title->hasFragment() ) { |
||
108 | $this->error( "Invalid title $pageName. Skipping.\n" ); |
||
109 | $skipCount++; |
||
110 | continue; |
||
111 | } |
||
112 | |||
113 | $exists = $title->exists(); |
||
114 | $oldRevID = $title->getLatestRevID(); |
||
115 | $oldRev = $oldRevID ? Revision::newFromId( $oldRevID ) : null; |
||
116 | $actualTitle = $title->getPrefixedText(); |
||
117 | |||
118 | if ( $exists ) { |
||
119 | $touched = wfTimestamp( TS_UNIX, $title->getTouched() ); |
||
120 | if ( !$overwrite ) { |
||
121 | $this->output( "Title $actualTitle already exists. Skipping.\n" ); |
||
122 | $skipCount++; |
||
123 | continue; |
||
124 | } elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) { |
||
125 | $this->output( "File for title $actualTitle has not been modified since the " . |
||
126 | "destination page was touched. Skipping.\n" ); |
||
127 | $skipCount++; |
||
128 | continue; |
||
129 | } |
||
130 | } |
||
131 | |||
132 | $rev = new WikiRevision( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) ); |
||
133 | $rev->setText( rtrim( $text ) ); |
||
134 | $rev->setTitle( $title ); |
||
135 | $rev->setUserObj( $user ); |
||
136 | $rev->setComment( $summary ); |
||
137 | $rev->setTimestamp( $timestamp ); |
||
138 | |||
139 | if ( $exists && $overwrite && $rev->getContent()->equals( $oldRev->getContent() ) ) { |
||
140 | $this->output( "File for title $actualTitle contains no changes from the current " . |
||
141 | "revision. Skipping.\n" ); |
||
142 | $skipCount++; |
||
143 | continue; |
||
144 | } |
||
145 | |||
146 | $status = $rev->importOldRevision(); |
||
147 | $newId = $title->getLatestRevID(); |
||
148 | |||
149 | if ( $status ) { |
||
150 | $action = $exists ? 'updated' : 'created'; |
||
151 | $this->output( "Successfully $action $actualTitle\n" ); |
||
152 | $successCount++; |
||
153 | } else { |
||
154 | $action = $exists ? 'update' : 'create'; |
||
155 | $this->output( "Failed to $action $actualTitle\n" ); |
||
156 | $failCount++; |
||
157 | $exit = 1; |
||
158 | } |
||
159 | |||
160 | // Create the RecentChanges entry if necessary |
||
161 | if ( $rc && $status ) { |
||
162 | if ( $exists ) { |
||
163 | if ( is_object( $oldRev ) ) { |
||
164 | $oldContent = $oldRev->getContent(); |
||
165 | RecentChange::notifyEdit( |
||
166 | $timestamp, |
||
167 | $title, |
||
168 | $rev->getMinor(), |
||
169 | $user, |
||
170 | $summary, |
||
171 | $oldRevID, |
||
172 | $oldRev->getTimestamp(), |
||
173 | $bot, |
||
174 | '', |
||
175 | $oldContent ? $oldContent->getSize() : 0, |
||
176 | $rev->getContent()->getSize(), |
||
177 | $newId, |
||
178 | 1 /* the pages don't need to be patrolled */ |
||
179 | ); |
||
180 | } |
||
181 | } else { |
||
182 | RecentChange::notifyNew( |
||
183 | $timestamp, |
||
184 | $title, |
||
185 | $rev->getMinor(), |
||
186 | $user, |
||
187 | $summary, |
||
188 | $bot, |
||
189 | '', |
||
190 | $rev->getContent()->getSize(), |
||
191 | $newId, |
||
192 | 1 |
||
193 | ); |
||
194 | } |
||
195 | } |
||
196 | } |
||
197 | |||
198 | $this->output( "Done! $successCount succeeded, $skipCount skipped.\n" ); |
||
199 | if ( $exit ) { |
||
200 | $this->error( "Import failed with $failCount failed pages.\n", $exit ); |
||
201 | } |
||
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.