WordPress.org

Make WordPress Core

Changeset 33984


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

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

Props wenthemes.
Fixes #33725.

Location:
trunk/src/wp-admin/includes
Files:
5 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
  • trunk/src/wp-admin/includes/class-wp-filesystem-direct.php

    r30978 r33984  
    2020     * constructor
    2121     *
     22     * @access public
     23     *
    2224     * @param mixed $arg ignored argument
    2325     */
     
    3032     * Reads entire file into a string
    3133     *
     34     * @access public
     35     *
    3236     * @param string $file Name of the file to read.
    3337     * @return string|bool The function returns the read data or false on failure.
     
    4044     * Reads entire file into an array
    4145     *
     46     * @access public
     47     *
    4248     * @param string $file Path to the file.
    4349     * @return array|bool the file contents in an array or false on failure.
     
    4955    /**
    5056     * Write a string to a file
     57     *
     58     * @access public
    5159     *
    5260     * @param string $file     Remote path to the file where to write the data.
     
    8290     * Gets the current working directory
    8391     *
     92     * @access public
     93     *
    8494     * @return string|bool the current working directory on success, or false on failure.
    8595     */
     
    91101     * Change directory
    92102     *
     103     * @access public
     104     *
    93105     * @param string $dir The new current directory.
    94106     * @return bool Returns true on success or false on failure.
     
    100112    /**
    101113     * Changes file group
     114     *
     115     * @access public
    102116     *
    103117     * @param string $file      Path to the file.
     
    125139     * Changes filesystem permissions
    126140     *
     141     * @access public
     142     *
    127143     * @param string $file      Path to the file.
    128144     * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files,
     
    154170    /**
    155171     * Changes file owner
     172     *
     173     * @access public
    156174     *
    157175     * @param string $file      Path to the file.
     
    179197     * Gets file owner
    180198     *
     199     * @access public
     200     *
    181201     * @param string $file Path to the file.
    182202     * @return string|bool Username of the user or false on error.
     
    197217     * FIXME does not handle errors in fileperms()
    198218     *
     219     * @access public
     220     *
    199221     * @param string $file Path to the file.
    200222     * @return string Mode of the file (last 3 digits).
     
    205227
    206228    /**
     229     * @access public
     230     *
    207231     * @param string $file
    208232     * @return string|false
     
    219243
    220244    /**
     245     * @access public
     246     *
    221247     * @param string $source
    222248     * @param string $destination
     
    236262
    237263    /**
     264     * @access public
     265     *
    238266     * @param string $source
    239267     * @param string $destination
     
    258286
    259287    /**
     288     * @access public
     289     *
    260290     * @param string $file
    261291     * @param bool $recursive
     
    291321    }
    292322    /**
     323     * @access public
     324     *
    293325     * @param string $file
    294326     * @return bool
     
    298330    }
    299331    /**
     332     * @access public
     333     *
    300334     * @param string $file
    301335     * @return bool
     
    305339    }
    306340    /**
     341     * @access public
     342     *
    307343     * @param string $path
    308344     * @return bool
     
    313349
    314350    /**
     351     * @access public
     352     *
    315353     * @param string $file
    316354     * @return bool
     
    321359
    322360    /**
     361     * @access public
     362     *
    323363     * @param string $file
    324364     * @return bool
     
    329369
    330370    /**
     371     * @access public
     372     *
    331373     * @param string $file
    332374     * @return int
     
    337379
    338380    /**
     381     * @access public
     382     *
    339383     * @param string $file
    340384     * @return int
     
    345389
    346390    /**
     391     * @access public
     392     *
    347393     * @param string $file
    348394     * @return int
     
    353399
    354400    /**
     401     * @access public
     402     *
    355403     * @param string $file
    356404     * @param int $time
     
    367415
    368416    /**
     417     * @access public
     418     *
    369419     * @param string $path
    370420     * @param mixed  $chmod
     
    393443
    394444    /**
     445     * @access public
     446     *
    395447     * @param string $path
    396448     * @param bool $recursive
     
    402454
    403455    /**
     456     * @access public
     457     *
    404458     * @param string $path
    405459     * @param bool $include_hidden
  • trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php

    r33648 r33984  
    1919
    2020    /**
     21     * @access public
    2122     *
    2223     * @param array $opt
     
    6465
    6566    /**
     67     * @access public
    6668     *
    6769     * @return bool
     
    9294
    9395    /**
     96     * @access public
     97     *
    9498     * @param string $file
    9599     * @return false|string
     
    117121
    118122    /**
     123     * @access public
     124     *
    119125     * @param string $file
    120126     * @return array
     
    125131
    126132    /**
     133     * @access public
     134     *
    127135     * @param string $file
    128136     * @param string $contents
     
    162170
    163171    /**
     172     * @access public
     173     *
    164174     * @return string
    165175     */
     
    172182
    173183    /**
     184     * @access public
     185     *
    174186     * @param string $dir
    175187     * @return bool
     
    180192
    181193    /**
     194     * @access public
     195     *
    182196     * @param string $file
    183197     * @param int $mode
     
    209223
    210224    /**
     225     * @access public
     226     *
    211227     * @param string $file
    212228     * @return string
     
    217233    }
    218234    /**
     235     * @access public
     236     *
    219237     * @param string $file
    220238     * @return string
     
    224242        return $dir[$file]['permsn'];
    225243    }
    226     /**
     244
     245    /**
     246     * @access public
     247     *
    227248     * @param string $file
    228249     * @return string
     
    234255
    235256    /**
     257     * @access public
    236258     *
    237259     * @param string $source
     
    249271        return $this->put_contents($destination, $content, $mode);
    250272    }
    251     /**
     273
     274    /**
     275     * @access public
     276     *
    252277     * @param string $source
    253278     * @param string $destination
     
    258283        return ftp_rename($this->link, $source, $destination);
    259284    }
    260     /**
     285
     286    /**
     287     * @access public
     288     *
    261289     * @param string $file
    262290     * @param bool $recursive
     
    278306        return @ftp_rmdir($this->link, $file);
    279307    }
    280     /**
     308
     309    /**
     310     * @access public
     311     *
    281312     * @param string $file
    282313     * @return bool
     
    291322        return !empty($list); //empty list = no file, so invert.
    292323    }
    293     /**
     324
     325    /**
     326     * @access public
     327     *
    294328     * @param string $file
    295329     * @return bool
     
    298332        return $this->exists($file) && !$this->is_dir($file);
    299333    }
    300     /**
     334
     335    /**
     336     * @access public
     337     *
    301338     * @param string $path
    302339     * @return bool
     
    313350
    314351    /**
     352     * @access public
     353     *
    315354     * @param string $file
    316355     * @return bool
     
    319358        return true;
    320359    }
    321     /**
     360
     361    /**
     362     * @access public
     363     *
    322364     * @param string $file
    323365     * @return bool
     
    326368        return true;
    327369    }
    328     /**
     370
     371    /**
     372     * @access public
     373     *
    329374     * @param string $file
    330375     * @return bool
     
    333378        return false;
    334379    }
    335     /**
     380
     381    /**
     382     * @access public
     383     *
    336384     * @param string $file
    337385     * @return int
     
    340388        return ftp_mdtm($this->link, $file);
    341389    }
    342     /**
     390
     391    /**
     392     * @access public
     393     *
    343394     * @param string $file
    344395     * @return int
     
    347398        return ftp_size($this->link, $file);
    348399    }
    349     /**
     400
     401    /**
     402     * @access public
     403     *
    350404     * @param string $file
    351405     * @return bool
     
    356410
    357411    /**
     412     * @access public
     413     *
    358414     * @param string $path
    359415     * @param mixed $chmod
     
    374430
    375431    /**
     432     * @access public
     433     *
    376434     * @param string $path
    377435     * @param bool $recursive
     
    383441
    384442    /**
     443     * @access public
     444     *
    385445     * @staticvar bool $is_windows
    386446     * @param string $line
     
    462522
    463523    /**
     524     * @access public
     525     *
    464526     * @param string $path
    465527     * @param bool $include_hidden
  • trunk/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php

    r33648 r33984  
    1717class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
    1818    /**
     19     * @access public
    1920     * @var ftp
    2021     */
     
    2223
    2324    /**
     25     * @access public
    2426     *
    2527     * @param array $opt
     
    5860
    5961    /**
     62     * @access public
    6063     *
    6164     * @return bool
     
    8992
    9093    /**
     94     * @access public
     95     *
    9196     * @param string $file
    9297     * @return false|string
     
    124129        return $contents;
    125130    }
    126     /**
     131
     132    /**
     133     * @access public
     134     *
    127135     * @param string $file
    128136     * @return array
     
    133141
    134142    /**
     143     * @access public
     144     *
    135145     * @param string $file
    136146     * @param string $contents
     
    173183
    174184    /**
     185     * @access public
    175186     *
    176187     * @return string
     
    184195
    185196    /**
     197     * @access public
    186198     *
    187199     * @param string $file
     
    193205
    194206    /**
     207     * @access public
     208     *
    195209     * @param string $file
    196210     * @param int|bool $mode
     
    220234
    221235    /**
     236     * @access public
     237     *
    222238     * @param string $file
    223239     * @return string
     
    227243        return $dir[$file]['owner'];
    228244    }
    229     /**
     245
     246    /**
     247     * @access public
     248     *
    230249     * @param string $file
    231250     * @return string
     
    235254        return $dir[$file]['permsn'];
    236255    }
    237     /**
     256
     257    /**
     258     * @access public
     259     *
    238260     * @param string $file
    239261     * @return string
     
    243265        return $dir[$file]['group'];
    244266    }
    245     /**
     267
     268    /**
     269     * @access public
     270     *
    246271     * @param string   $source
    247272     * @param string   $destination
     
    260285        return $this->put_contents($destination, $content, $mode);
    261286    }
    262     /**
     287
     288    /**
     289     * @access public
     290     *
    263291     * @param string $source
    264292     * @param string $destination
     
    269297        return $this->ftp->rename($source, $destination);
    270298    }
    271     /**
     299
     300    /**
     301     * @access public
     302     *
    272303     * @param string $file
    273304     * @param bool   $recursive
     
    287318
    288319    /**
     320     * @access public
     321     *
    289322     * @param string $file
    290323     * @return bool
     
    302335
    303336    /**
     337     * @access public
     338     *
    304339     * @param string $file
    305340     * @return bool
     
    314349
    315350    /**
     351     * @access public
     352     *
    316353     * @param string $path
    317354     * @return bool
     
    327364
    328365    /**
     366     * @access public
     367     *
    329368     * @param string $file
    330369     * @return bool
     
    335374
    336375    /**
     376     * @access public
     377     *
    337378     * @param string $file
    338379     * @return bool
     
    343384
    344385    /**
     386     * @access public
     387     *
    345388     * @param string $file
    346389     * @return bool
     
    351394
    352395    /**
     396     * @access public
     397     *
    353398     * @param string $file
    354399     * @return int
     
    365410        return $this->ftp->filesize($file);
    366411    }
    367     /**
     412
     413    /**
     414     * @access public
     415     *
    368416     * @param string $file
    369417     * @param int $time
     
    376424
    377425    /**
     426     * @access public
     427     *
    378428     * @param string $path
    379429     * @param mixed  $chmod
     
    396446
    397447    /**
     448     * @access public
     449     *
    398450     * @param string $path
    399451     * @param bool $recursive
     
    404456
    405457    /**
     458     * @access public
     459     *
    406460     * @param string $path
    407461     * @param bool   $include_hidden
  • trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

    r33688 r33984  
    3636class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
    3737
     38    /**
     39     * @access public
     40     */
    3841    public $link = false;
    39     /**
     42
     43    /**
     44     * @access public
    4045     * @var resource
    4146     */
     
    4449
    4550    /**
     51     * @access public
    4652     *
    4753     * @param array $opt
     
    97103
    98104    /**
     105     * @access public
    99106     *
    100107     * @return bool
     
    130137
    131138    /**
     139     * @access public
     140     *
    132141     * @param string $command
    133142     * @param bool $returnbool
     
    155164
    156165    /**
     166     * @access public
     167     *
    157168     * @param string $file
    158169     * @return string|false
     
    164175
    165176    /**
     177     * @access public
     178     *
    166179     * @param string $file
    167180     * @return array
     
    173186
    174187    /**
     188     * @access public
     189     *
    175190     * @param string   $file
    176191     * @param string   $contents
     
    190205
    191206    /**
     207     * @access public
    192208     *
    193209     * @return bool
     
    202218
    203219    /**
     220     * @access public
     221     *
    204222     * @param string $dir
    205223     * @return bool|string
     
    210228
    211229    /**
     230     * @access public
     231     *
    212232     * @param string $file
    213233     * @param string $group
     
    225245
    226246    /**
     247     * @access public
     248     *
    227249     * @param string $file
    228250     * @param int    $mode
     
    251273     * Change the ownership of a file / folder.
    252274     *
    253      * @since Unknown
     275     * @access public
    254276     *
    255277     * @param string     $file    Path to the file.
     
    267289
    268290    /**
     291     * @access public
     292     *
    269293     * @param string $file
    270294     * @return string|false
     
    279303        return $ownerarray['name'];
    280304    }
    281     /**
     305
     306    /**
     307     * @access public
     308     *
    282309     * @param string $file
    283310     * @return string
     
    288315
    289316    /**
     317     * @access public
     318     *
    290319     * @param string $file
    291320     * @return string|false
     
    302331
    303332    /**
     333     * @access public
     334     *
    304335     * @param string   $source
    305336     * @param string   $destination
     
    318349
    319350    /**
     351     * @access public
     352     *
    320353     * @param string $source
    321354     * @param string $destination
     
    328361
    329362    /**
     363     * @access public
     364     *
    330365     * @param string      $file
    331366     * @param bool        $recursive
     
    348383
    349384    /**
     385     * @access public
     386     *
    350387     * @param string $file
    351388     * @return bool
     
    355392        return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
    356393    }
    357     /**
     394
     395    /**
     396     * @access public
     397     *
    358398     * @param string $file
    359399     * @return bool
     
    363403        return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
    364404    }
    365     /**
     405
     406    /**
     407     * @access public
     408     *
    366409     * @param string $path
    367410     * @return bool
     
    371414        return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
    372415    }
    373     /**
     416
     417    /**
     418     * @access public
     419     *
    374420     * @param string $file
    375421     * @return bool
     
    379425        return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
    380426    }
    381     /**
     427
     428    /**
     429     * @access public
     430     *
    382431     * @param string $file
    383432     * @return bool
     
    387436        return true;
    388437    }
    389     /**
     438
     439    /**
     440     * @access public
     441     *
    390442     * @param string $file
    391443     * @return int
     
    397449
    398450    /**
     451     * @access public
     452     *
    399453     * @param string $file
    400454     * @return int
     
    406460
    407461    /**
     462     * @access public
     463     *
    408464     * @param string $file
    409465     * @return int
     
    415471
    416472    /**
     473     * @access public
     474     *
    417475     * @param string $file
    418476     * @param int    $time
     
    424482
    425483    /**
     484     * @access public
     485     *
    426486     * @param string $path
    427487     * @param mixed  $chmod
     
    447507
    448508    /**
     509     * @access public
     510     *
    449511     * @param string $path
    450512     * @param bool   $recursive
     
    456518
    457519    /**
     520     * @access public
     521     *
    458522     * @param string $path
    459523     * @param bool   $include_hidden
Note: See TracChangeset for help on using the changeset viewer.