mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2025-03-12 20:49:50 +00:00
Merge pull request #1700 from bcrowe/hotfix-filedocblocks
Updated returns in docblocks in File utility
This commit is contained in:
Mark Story
commit
ba1eb7e495
1 changed files with 40 additions and 40 deletions
|
|
@ -28,7 +28,7 @@ App::uses('Folder', 'Utility');
|
|||
class File {
|
||||
|
||||
/**
|
||||
* Folder object of the File
|
||||
* Folder object of the file
|
||||
*
|
||||
* @var Folder
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$Folder
|
||||
|
|
@ -36,7 +36,7 @@ class File {
|
|||
public $Folder = null;
|
||||
|
||||
/**
|
||||
* Filename
|
||||
* File name
|
||||
*
|
||||
* @var string
|
||||
* http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::$name
|
||||
|
|
@ -103,7 +103,7 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Creates the File.
|
||||
* Creates the file.
|
||||
*
|
||||
* @return boolean Success
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::create
|
||||
|
|
@ -144,7 +144,7 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Return the contents of this File as a string.
|
||||
* Return the contents of this file as a string.
|
||||
*
|
||||
* @param string $bytes where to start
|
||||
* @param string $mode A `fread` compatible mode.
|
||||
|
|
@ -200,8 +200,8 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Prepares a ascii string for writing. Converts line endings to the
|
||||
* correct terminator for the current platform. If windows "\r\n" will be used
|
||||
* Prepares a ASCII string for writing. Converts line endings to the
|
||||
* correct terminator for the current platform. If Windows, "\r\n" will be used,
|
||||
* all other platforms will use "\n"
|
||||
*
|
||||
* @param string $data Data to prepare for writing.
|
||||
|
|
@ -218,11 +218,11 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Write given data to this File.
|
||||
* Write given data to this file.
|
||||
*
|
||||
* @param string $data Data to write to this File.
|
||||
* @param string $mode Mode of writing. {@link http://php.net/fwrite See fwrite()}.
|
||||
* @param string $force force the file to open
|
||||
* @param string $force Force the file to open
|
||||
* @return boolean Success
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::write
|
||||
*/
|
||||
|
|
@ -246,10 +246,10 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Append given data string to this File.
|
||||
* Append given data string to this file.
|
||||
*
|
||||
* @param string $data Data to write
|
||||
* @param string $force force the file to open
|
||||
* @param string $force Force the file to open
|
||||
* @return boolean Success
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::append
|
||||
*/
|
||||
|
|
@ -271,7 +271,7 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Deletes the File.
|
||||
* Deletes the file.
|
||||
*
|
||||
* @return boolean Success
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::delete
|
||||
|
|
@ -288,7 +288,7 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the File info as an array with the following keys:
|
||||
* Returns the file info as an array with the following keys:
|
||||
*
|
||||
* - dirname
|
||||
* - basename
|
||||
|
|
@ -317,9 +317,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the File extension.
|
||||
* Returns the file extension.
|
||||
*
|
||||
* @return string The File extension
|
||||
* @return string The file extension
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::ext
|
||||
*/
|
||||
public function ext() {
|
||||
|
|
@ -333,9 +333,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the File name without extension.
|
||||
* Returns the file name without extension.
|
||||
*
|
||||
* @return string The File name without extension.
|
||||
* @return string The file name without extension.
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::name
|
||||
*/
|
||||
public function name() {
|
||||
|
|
@ -351,11 +351,11 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* makes filename safe for saving
|
||||
* Makes file name safe for saving
|
||||
*
|
||||
* @param string $name The name of the file to make safe if different from $this->name
|
||||
* @param string $ext The name of the extension to make safe if different from $this->ext
|
||||
* @return string $ext the extension of the file
|
||||
* @return string $ext The extension of the file
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::safe
|
||||
*/
|
||||
public function safe($name = null, $ext = null) {
|
||||
|
|
@ -372,7 +372,7 @@ class File {
|
|||
* Get md5 Checksum of file with previous check of Filesize
|
||||
*
|
||||
* @param integer|boolean $maxsize in MB or true to force
|
||||
* @return string md5 Checksum {@link http://php.net/md5_file See md5_file()}
|
||||
* @return string|false md5 Checksum {@link http://php.net/md5_file See md5_file()}, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::md5
|
||||
*/
|
||||
public function md5($maxsize = 5) {
|
||||
|
|
@ -389,9 +389,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the full path of the File.
|
||||
* Returns the full path of the file.
|
||||
*
|
||||
* @return string Full path to file
|
||||
* @return string Full path to the file
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::pwd
|
||||
*/
|
||||
public function pwd() {
|
||||
|
|
@ -402,9 +402,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if the File exists.
|
||||
* Returns true if the file exists.
|
||||
*
|
||||
* @return boolean true if it exists, false otherwise
|
||||
* @return boolean True if it exists, false otherwise
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::exists
|
||||
*/
|
||||
public function exists() {
|
||||
|
|
@ -413,9 +413,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the "chmod" (permissions) of the File.
|
||||
* Returns the "chmod" (permissions) of the file.
|
||||
*
|
||||
* @return string Permissions for the file
|
||||
* @return string|false Permissions for the file, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::perms
|
||||
*/
|
||||
public function perms() {
|
||||
|
|
@ -426,9 +426,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the Filesize
|
||||
* Returns the file size
|
||||
*
|
||||
* @return integer size of the file in bytes, or false in case of an error
|
||||
* @return integer|false Size of the file in bytes, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::size
|
||||
*/
|
||||
public function size() {
|
||||
|
|
@ -439,9 +439,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if the File is writable.
|
||||
* Returns true if the file is writable.
|
||||
*
|
||||
* @return boolean true if its writable, false otherwise
|
||||
* @return boolean True if it's writable, false otherwise
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::writable
|
||||
*/
|
||||
public function writable() {
|
||||
|
|
@ -451,7 +451,7 @@ class File {
|
|||
/**
|
||||
* Returns true if the File is executable.
|
||||
*
|
||||
* @return boolean true if its executable, false otherwise
|
||||
* @return boolean True if it's executable, false otherwise
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::executable
|
||||
*/
|
||||
public function executable() {
|
||||
|
|
@ -459,9 +459,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns true if the File is readable.
|
||||
* Returns true if the file is readable.
|
||||
*
|
||||
* @return boolean true if file is readable, false otherwise
|
||||
* @return boolean True if file is readable, false otherwise
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::readable
|
||||
*/
|
||||
public function readable() {
|
||||
|
|
@ -469,9 +469,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the File's owner.
|
||||
* Returns the file's owner.
|
||||
*
|
||||
* @return integer the Fileowner
|
||||
* @return integer|false The file owner, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::owner
|
||||
*/
|
||||
public function owner() {
|
||||
|
|
@ -482,9 +482,9 @@ class File {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the File's group.
|
||||
* Returns the file's group.
|
||||
*
|
||||
* @return integer the Filegroup
|
||||
* @return integer|false The file group, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::group
|
||||
*/
|
||||
public function group() {
|
||||
|
|
@ -497,7 +497,7 @@ class File {
|
|||
/**
|
||||
* Returns last access time.
|
||||
*
|
||||
* @return integer timestamp Timestamp of last access time
|
||||
* @return integer|false Timestamp of last access time, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::lastAccess
|
||||
*/
|
||||
public function lastAccess() {
|
||||
|
|
@ -510,7 +510,7 @@ class File {
|
|||
/**
|
||||
* Returns last modified time.
|
||||
*
|
||||
* @return integer timestamp Timestamp of last modification
|
||||
* @return integer|false Timestamp of last modification, or false in case of an error
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::lastChange
|
||||
*/
|
||||
public function lastChange() {
|
||||
|
|
@ -533,7 +533,7 @@ class File {
|
|||
/**
|
||||
* Copy the File to $dest
|
||||
*
|
||||
* @param string $dest destination for the copy
|
||||
* @param string $dest Destination for the copy
|
||||
* @param boolean $overwrite Overwrite $dest if exists
|
||||
* @return boolean Success
|
||||
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::copy
|
||||
|
|
@ -573,7 +573,7 @@ class File {
|
|||
/**
|
||||
* Clear PHP's internal stat cache
|
||||
*
|
||||
* For 5.3 onwards its possible to clear cache for just a single file. Passing true
|
||||
* For 5.3 onwards it's possible to clear cache for just a single file. Passing true
|
||||
* will clear all the stat cache.
|
||||
*
|
||||
* @param boolean $all Clear all cache or not
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue