Commit Graph

36 Commits

Author SHA1 Message Date
Drew Jaynes 829139ba1a Docs: Remove `@access` notations from method DocBlocks in wp-admin/* classes.
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41161 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-27 00:39:34 +00:00
Drew Jaynes de87b6d828 Docs: Remove superfluous `@package WordPress` and `@subpackage` notations used outside of file headers in a variety of core files.
Per the inline documentation standards for PHP, there should only be one `@package` and/or `@subpackage` notation per file, and only in the file header.

See #41017.


git-svn-id: https://develop.svn.wordpress.org/trunk@40988 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-01 16:57:13 +00:00
Dion Hulse 3a4aae8c20 Filesystem: Add `return` statement to `WP_Filesystem_ftpsockets->rmdir`
Props tymvie.
Fixes #39405.


git-svn-id: https://develop.svn.wordpress.org/trunk@39644 602fd350-edb4-49c9-b593-d223f7449a82
2016-12-28 03:51:29 +00:00
Scott Taylor cba0e2c8f7 Bootstrap: do not go gentle into that good night r38411, r38412, and parts of r38389.
See #36335.


git-svn-id: https://develop.svn.wordpress.org/trunk@38470 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-31 16:30:48 +00:00
Scott Taylor 4225e71a6b Bootstrap: after r38409 and r38410, revert r38402 which reverted r38399.
This fixes the paths in `wp-vendor/` that were including `src`. I want to drop this in so we can find out what else will break.

See #36335.


git-svn-id: https://develop.svn.wordpress.org/trunk@38411 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-27 22:31:11 +00:00
Dion Hulse e353179ce5 Bootstrap: Revert [38399] as it's broken `/build/` and subsequently core.svn.wordpress.org.
The generated classmaps reference `/src/` files and operates in the assumption that the base directory is one level above `wp-settings.php`, which it isn't after our build processes are run.

See #36335


git-svn-id: https://develop.svn.wordpress.org/trunk@38402 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-27 14:36:42 +00:00
Scott Taylor 388690382c Bootstrap: Autoload classes using a Composer-generated PHP 5.2-compatible Autoloader.
* `wp-admin` and `wp-includes` are scanned for classes to autoload
* Several 3rd-party and Ryan McCue-shaped libraries are excluded when the classmap is generated, see `composer.json`: `autoload.exclude-from-classmap`
* `wp-vendor/autoload_52.php` is included at the top of `wp-settings.php` - no changes need to be made to unit tests to include the autoloader
* An avalanche of `require()` and `require_once()` calls that loaded class files have been removed from the codebase.

The following files have been added to `svn:ignore` - they are not 5.2-compatible and fail during pre-commit:
* src/wp-vendor/autoload.php
* src/wp-vendor/composer/autoload_real.php
* src/wp-vendor/composer/autoload_static.php
* src/wp-vendor/composer/ClassLoader.php

We favor these files instead:
* src/wp-vendor/autoload_52.php
* src/wp-vendor/composer/autoload_real_52.php
* src/wp-vendor/composer/ClassLoader52.php

When new PHP classes are added to the codebase, simply run `composer install` or `composer update` from the project root to update the autoloader.

The future is now.

See #36335.


git-svn-id: https://develop.svn.wordpress.org/trunk@38399 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-27 09:15:01 +00:00
Dominik Schilling ff6d8819e4 Filesystem API: Cleanup temporary file when the temporary file couldn't be opened.
Props ruud@joyo.
See #34772.
Fixes #36942, #36943.

git-svn-id: https://develop.svn.wordpress.org/trunk@38094 602fd350-edb4-49c9-b593-d223f7449a82
2016-07-18 19:42:48 +00:00
Dion Hulse 5564545ea8 Filesystem: Revert [33648] and [34733] unfortunately these have caused issues for some servers, while fixing it for others.
See #28013

Fixes #34976 for trunk
Fixes #34976 for trunk


git-svn-id: https://develop.svn.wordpress.org/trunk@35944 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-15 02:35:26 +00:00
Dion Hulse f6972f0fae Filesystem API: Cast the port to an int in the FTPSockets class. PemFTP requires that the port be specified as an integer, not a numeric string.
Fixes #35088


git-svn-id: https://develop.svn.wordpress.org/trunk@35942 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-15 00:28:59 +00:00
Sergey Biryukov 7ce972bb33 I18N: Add translator comments for strings in `wp-admin/includes/class-wp-filesystem-ftpsockets.php`.
Fixes #34684.

git-svn-id: https://develop.svn.wordpress.org/trunk@35664 602fd350-edb4-49c9-b593-d223f7449a82
2015-11-18 17:22:34 +00:00
Drew Jaynes 02e1102a5b Docs: Add a summary, version, and parameter and return descriptions to the DocBlock for `WP_Filesystem_ftpsockets::get_contents()`.
Also reverses the return types as `string` is expected, `false` is the outlier.

See [30978].

See #30989. See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34495 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-24 14:21:50 +00:00
Scott Taylor 89f4c471fa Add `@access` docs to `class-wp-filesystem-*` files.
Props wenthemes.
Fixes #33725.


git-svn-id: https://develop.svn.wordpress.org/trunk@33984 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-10 01:20:58 +00:00
Dion Hulse f0ec4d5a7b Upgrades: When upgrading via FTP, use `LIST -a` to detect if a file exists.
`LIST` & `NLST` by default on some servers require the `-a` flag to view hidden files (ie. `.maintenance`)
Although we could simply pass the `-a` flag to `NLST`, opting to use `LIST` which we use elsewhere should mean less chance of server incompatibilities.

Props jcroucher.
Fixes #28013.


git-svn-id: https://develop.svn.wordpress.org/trunk@33648 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-19 12:37:56 +00:00
Scott Taylor 69338b3fa7 Correct typo in doc block for `WP_Filesystem_ftpsockets::rmdir`
Props Toro_Unit.
Fixes #33255.


git-svn-id: https://develop.svn.wordpress.org/trunk@33639 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-18 23:33:00 +00:00
Dion Hulse fc52d9cbb1 WP Filesystem: Correctly parse the permissions field in the directory listings, and actually set it in FTP environments
Props mnelson4 for initial patch.
Fixes #29548


git-svn-id: https://develop.svn.wordpress.org/trunk@32923 602fd350-edb4-49c9-b593-d223f7449a82
2015-06-24 04:48:18 +00:00
Scott Taylor c49c139a22 Add `@access` annotations to methods that have no doc block in `wp-admin/includes/*`.
Makes it easier to search for no doc blocks via `}[\n\t\r ]+(protected|private|public)`.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32656 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-29 21:31:56 +00:00
Scott Taylor ec5758225c Add missing doc blocks to `wp-admin/includes/*`.
Fix some egregious uses of tabbing.
Some functions can simply return `apply_filters(...)` instead of setting a variable that is immediately returned.

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32654 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-29 20:16:22 +00:00
Dominik Schilling (ocean90) e9da1dc1f2 WP_Filesystem: Change `WP_Filesystem_FTPext::exists()` and `WP_Filesystem_ftpsockets::exists()` to return true for empty directories.
Both methods are using *nlist() which returns a list of files in a given directory or the file itself for a given file. If the result was an empty list we assumed that the file doesn't exists. This includes also cases where $file is actually an empty directory. To prevent this we now check if $file is a directory before returning the result of an empty list.
Other filesystem methods are using `file_exists()` which already checks whether a file or directory exists.

fixes #30815.

git-svn-id: https://develop.svn.wordpress.org/trunk@31815 602fd350-edb4-49c9-b593-d223f7449a82
2015-03-18 19:21:33 +00:00
Scott Taylor 1d3b42d226 Fix some erroneous `@param` annotations.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31219 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 22:43:13 +00:00
Scott Taylor 2ed007c023 Calling `->chown()` and `->chgrp()` in `WP_Filesystem_ftpsockets` produces no side-effects. Remove the calls. `->chgrp()` is defined in the super class, and does nothing, can be removed from the child class.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31216 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 21:09:18 +00:00
Scott Taylor 07d899740e In `WP_Filesystem_Base` subclasses that set `$wp_base`, remove this dead code.
Unused since [8009] - "Make WP_Filesystem work with new directory constants"

There is currently no declared field and no `@property` annotation.

See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31209 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 17:22:07 +00:00
Scott Taylor b0c6a64fbd `WP_Filesystem_Base` should declare `$errors` and `$options` as fields for use by subclasses.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31208 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-16 17:09:35 +00:00
Scott Taylor 349e5cb318 Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Constructors do not have meaningful return values, anything that is returned from here is discarded.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31126 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-10 06:53:48 +00:00
Scott Taylor 04ed6499cd Improve some `wp-admin/includes/class-wp-filesystem-*.php` docs for `@param`.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@30978 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-20 20:39:41 +00:00
Scott Taylor 7a7bb0d6b4 Improve various `@param` docs for `src/wp-admin/includes/class-wp-filesystem-*.php`.
See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30678 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-01 00:12:05 +00:00
Drew Jaynes (DrewAPicture) 6ddc1e5f6d Fix syntax for single- and multi-line comments in wp-admin-directory files.
See #28931.


git-svn-id: https://develop.svn.wordpress.org/trunk@29206 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-17 09:13:53 +00:00
Scott Taylor e43d2a73d8 Fix some `hackificator` odds and ends in `wp-admin`:
* `wp-activate.php` and `wp-admin/themes.php` don't need the closing PHP tag
* Switch single quotes for HTML attribute values to double in a few places
* Convert `include_once file.php` syntax to `include_once( 'file.php' )`
* Add access modifiers to methods/members in: `_WP_List_Table_Compat`, `Walker_Nav_Menu_Edit`, `Walker_Nav_Menu_Checklist`, `WP_Screen`, `Walker_Category_Checklist`
* `edit_user()` doesn't need to import the `$wpdb` global
* `wp_list_widgets()` doesn't need to import the `$sidebars_widgets` global
* switch/endswitch syntax is not supported in Hack
* A `<ul>` in `wp-admin/users.php` is unclosed

See #27881.


git-svn-id: https://develop.svn.wordpress.org/trunk@28500 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 05:03:44 +00:00
Scott Taylor fce8b1e0c3 Add access modifier (`public`) to members and methods in `WP_Filesystem_ftpsockets`.
See #27881, #22234.


git-svn-id: https://develop.svn.wordpress.org/trunk@28490 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 00:13:29 +00:00
Sergey Biryukov 329672c70d Being consistent is the gist, no single @since should have been missed.
see #26713.

git-svn-id: https://develop.svn.wordpress.org/trunk@26869 602fd350-edb4-49c9-b593-d223f7449a82
2013-12-25 01:59:22 +00:00
Dion Hulse 455b8d47a9 First pass at documenting the WP_Filesystem methods. This also introduces stubs of the methods into the base class which are documented, which subclasses can override, some methods were cleaned up at the same time.
See #18476 See #23122. Props kurtpayne, bananastalktome, and, DrewAPicture 


git-svn-id: https://develop.svn.wordpress.org/trunk@25560 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-22 04:43:29 +00:00
Dion Hulse ea6da7d5dc Make use of the mbstring.func_overload helper functions in WP_Filesystem so byte lengths are properly determined. See #25259 Fixes #25237
git-svn-id: https://develop.svn.wordpress.org/trunk@25349 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-11 08:26:57 +00:00
Dion Hulse beaf91c019 WP_Filesystem: Let the code breathe, add some additional whitespace between method definitions and comments.
git-svn-id: https://develop.svn.wordpress.org/trunk@25305 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-09 02:54:50 +00:00
Dion Hulse 2f40784d97 WP_Filesystem: Ensure that all files are read/written correctly by verifying the return values from fwrite() and using FTP_BINARY mode (ASCII converts line endings as per the spec). See #25237
git-svn-id: https://develop.svn.wordpress.org/trunk@25304 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-09 02:42:52 +00:00
Dion Hulse d9c5265303 WP_Filesystem: FTP Sockets: Avoid using the file_exists() / is_exists() / exists() PemFTP functionality as it's buggy on ncFTPd servers, switching to listing the file instead which is what we use for the FTP Extension transport. Fixes #14049
git-svn-id: https://develop.svn.wordpress.org/trunk@25274 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-06 08:28:59 +00:00
Andrew Nacin b43712e0f7 New develop.svn.wordpress.org repository based on the old core.svn repository.
* All WordPress files move to a src/ directory.
 * New task runner (Grunt), configured to copy a built WordPress to build/.
 * svn:ignore and .gitignore for Gruntfile.js, wp-config.php, and node.js.
 * Remove Akismet external from develop.svn. Still exists in core.svn.
 * Drop minified files from src/. The build process will now generate these.

props koop.
see #24976.

and see http://wp.me/p2AvED-1AI.



git-svn-id: https://develop.svn.wordpress.org/trunk@25001 602fd350-edb4-49c9-b593-d223f7449a82
2013-08-07 05:25:25 +00:00