Make WordPress Core


Ignore:
Timestamp:
09/10/2015 01:20:58 AM (10 years ago)
Author:
wonderboymusic
Message:

Add @access docs to class-wp-filesystem-* files.

Props wenthemes.
Fixes #33725.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-filesystem-base.php

    r32962 r33984  
    2525     * Cached list of local filepaths to mapped remote filepaths.
    2626     *
     27     * @access public
    2728     * @since 2.7.0
    2829     * @var array
     
    3940    public $method = '';
    4041
     42    /**
     43     * @access public
     44     */
    4145    public $errors = null;
    4246
     47    /**
     48     * @access public
     49     */
    4350    public $options = array();
    4451
     
    231238     * Expects Windows sanitized path.
    232239     *
     240     * @access public
    233241     * @since 2.7.0
    234242     *
     
    355363     * Gets the permissions of the specified file or filepath in their octal format
    356364     *
     365     * @access public
    357366     * @since 2.5.0
    358367     * @param string $file
     
    402411     * Determine if the string provided contains binary characters.
    403412     *
     413     * @access public
    404414     * @since 2.7.0
    405415     *
     
    416426     * Default behavior is to do nothing, override this in your subclass, if desired.
    417427     *
     428     * @access public
    418429     * @since 2.5.0
    419430     *
     
    430441     * Connect filesystem.
    431442     *
    432      * @since 2.5.0
    433      * @abstract
     443     * @access public
     444     * @since 2.5.0
     445     * @abstract
     446     *
    434447     * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
    435448     */
     
    441454     * Read entire file into a string.
    442455     *
    443      * @since 2.5.0
    444      * @abstract
     456     * @access public
     457     * @since 2.5.0
     458     * @abstract
     459     *
    445460     * @param string $file Name of the file to read.
    446461     * @return mixed|bool Returns the read data or false on failure.
     
    453468     * Read entire file into an array.
    454469     *
    455      * @since 2.5.0
    456      * @abstract
     470     * @access public
     471     * @since 2.5.0
     472     * @abstract
     473     *
    457474     * @param string $file Path to the file.
    458475     * @return array|bool the file contents in an array or false on failure.
     
    465482     * Write a string to a file.
    466483     *
    467      * @since 2.5.0
    468      * @abstract
     484     * @access public
     485     * @since 2.5.0
     486     * @abstract
     487     *
    469488     * @param string $file     Remote path to the file where to write the data.
    470489     * @param string $contents The data to write.
     
    479498     * Get the current working directory.
    480499     *
    481      * @since 2.5.0
    482      * @abstract
     500     * @access public
     501     * @since 2.5.0
     502     * @abstract
     503     *
    483504     * @return string|bool The current working directory on success, or false on failure.
    484505     */
     
    490511     * Change current directory.
    491512     *
    492      * @since 2.5.0
    493      * @abstract
     513     * @access public
     514     * @since 2.5.0
     515     * @abstract
     516     *
    494517     * @param string $dir The new current directory.
    495518     * @return bool|string
     
    502525     * Change the file group.
    503526     *
    504      * @since 2.5.0
    505      * @abstract
     527     * @access public
     528     * @since 2.5.0
     529     * @abstract
     530     *
    506531     * @param string $file      Path to the file.
    507532     * @param mixed  $group     A group name or number.
     
    516541     * Change filesystem permissions.
    517542     *
    518      * @since 2.5.0
    519      * @abstract
     543     * @access public
     544     * @since 2.5.0
     545     * @abstract
     546     *
    520547     * @param string $file      Path to the file.
    521548     * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
     
    530557     * Get the file owner.
    531558     *
    532      * @since 2.5.0
    533      * @abstract
     559     * @access public
     560     * @since 2.5.0
     561     * @abstract
     562     *
    534563     * @param string $file Path to the file.
    535564     * @return string|bool Username of the user or false on error.
     
    542571     * Get the file's group.
    543572     *
    544      * @since 2.5.0
    545      * @abstract
     573     * @access public
     574     * @since 2.5.0
     575     * @abstract
     576     *
    546577     * @param string $file Path to the file.
    547578     * @return string|bool The group or false on error.
     
    554585     * Copy a file.
    555586     *
    556      * @since 2.5.0
    557      * @abstract
     587     * @access public
     588     * @since 2.5.0
     589     * @abstract
     590     *
    558591     * @param string $source      Path to the source file.
    559592     * @param string $destination Path to the destination file.
     
    571604     * Move a file.
    572605     *
    573      * @since 2.5.0
    574      * @abstract
     606     * @access public
     607     * @since 2.5.0
     608     * @abstract
     609     *
    575610     * @param string $source      Path to the source file.
    576611     * @param string $destination Path to the destination file.
     
    586621     * Delete a file or directory.
    587622     *
    588      * @since 2.5.0
    589      * @abstract
     623     * @access public
     624     * @since 2.5.0
     625     * @abstract
     626     *
    590627     * @param string $file      Path to the file.
    591628     * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
     
    602639     * Check if a file or directory exists.
    603640     *
    604      * @since 2.5.0
    605      * @abstract
     641     * @access public
     642     * @since 2.5.0
     643     * @abstract
     644     *
    606645     * @param string $file Path to file/directory.
    607646     * @return bool Whether $file exists or not.
     
    614653     * Check if resource is a file.
    615654     *
    616      * @since 2.5.0
    617      * @abstract
     655     * @access public
     656     * @since 2.5.0
     657     * @abstract
     658     *
    618659     * @param string $file File path.
    619660     * @return bool Whether $file is a file.
     
    626667     * Check if resource is a directory.
    627668     *
    628      * @since 2.5.0
    629      * @abstract
     669     * @access public
     670     * @since 2.5.0
     671     * @abstract
     672     *
    630673     * @param string $path Directory path.
    631674     * @return bool Whether $path is a directory.
     
    638681     * Check if a file is readable.
    639682     *
    640      * @since 2.5.0
    641      * @abstract
     683     * @access public
     684     * @since 2.5.0
     685     * @abstract
     686     *
    642687     * @param string $file Path to file.
    643688     * @return bool Whether $file is readable.
     
    650695     * Check if a file or directory is writable.
    651696     *
    652      * @since 2.5.0
    653      * @abstract
     697     * @access public
     698     * @since 2.5.0
     699     * @abstract
     700     *
    654701     * @return bool Whether $file is writable.
    655702     */
     
    661708     * Gets the file's last access time.
    662709     *
    663      * @since 2.5.0
    664      * @abstract
     710     * @access public
     711     * @since 2.5.0
     712     * @abstract
     713     *
    665714     * @param string $file Path to file.
    666715     * @return int|bool Unix timestamp representing last access time.
     
    673722     * Gets the file modification time.
    674723     *
    675      * @since 2.5.0
    676      * @abstract
     724     * @access public
     725     * @since 2.5.0
     726     * @abstract
     727     *
    677728     * @param string $file Path to file.
    678729     * @return int|bool Unix timestamp representing modification time.
     
    685736     * Gets the file size (in bytes).
    686737     *
    687      * @since 2.5.0
    688      * @abstract
     738     * @access public
     739     * @since 2.5.0
     740     * @abstract
     741     *
    689742     * @param string $file Path to file.
    690743     * @return int|bool Size of the file in bytes.
     
    699752     * Note: If $file doesn't exist, it will be created.
    700753     *
    701      * @since 2.5.0
    702      * @abstract
     754     * @access public
     755     * @since 2.5.0
     756     * @abstract
     757     *
    703758     * @param string $file  Path to file.
    704759     * @param int    $time  Optional. Modified time to set for file.
     
    715770     * Create a directory.
    716771     *
    717      * @since 2.5.0
    718      * @abstract
     772     * @access public
     773     * @since 2.5.0
     774     * @abstract
     775     *
    719776     * @param string $path  Path for new directory.
    720777     * @param mixed  $chmod Optional. The permissions as octal number, (or False to skip chmod)
     
    733790     * Delete a directory.
    734791     *
    735      * @since 2.5.0
    736      * @abstract
     792     * @access public
     793     * @since 2.5.0
     794     * @abstract
     795     *
    737796     * @param string $path      Path to directory.
    738797     * @param bool   $recursive Optional. Whether to recursively remove files/directories.
     
    747806     * Get details for files in a directory or a specific file.
    748807     *
     808     * @access public
    749809     * @since 2.5.0
    750810     * @abstract
Note: See TracChangeset for help on using the changeset viewer.