How to use the filesystem package - Revision history

Adjei7: /* Example */

2019-12-09T08:10:32Z

Example

← Older revision		Revision as of 08:10, 9 December 2019
Line 86:		Line 86:
	*/		*/
	// Retrieve file details from uploaded file, sent from upload form		// Retrieve file details from uploaded file, sent from upload form
	$file = JFactory::getApplication()->input->get('file_upload');		$file = JFactory::getApplication()->input->files->get('file_upload');

	// Import filesystem libraries. Perhaps not necessary, but does not hurt.		// Import filesystem libraries. Perhaps not necessary, but does not hurt.

N6REJ: /* Clean the Filename */ Replaced with currently ( 3.9.11 ) working method.

2019-09-15T16:11:12Z

Clean the Filename: Replaced with currently ( 3.9.11 ) working method.

← Older revision		Revision as of 16:11, 15 September 2019
Line 30:		Line 30:

	==Clean the Filename==		==Clean the Filename==
			Use:
			It cleans out all odd characters from a filename and returns a safe filename.

	Syntax:		Syntax:
	<source lang=php>		<source lang=php>
	$safefilename = ~~JFile~~::makeSafe($filename);		$safefilename = File::makeSafe($filename);
			</source>


			REQUIRES:
			<source lang=php>
			use Joomla\CMS\Filesystem\File;
	</source>		</source>
	~~It cleans out all odd characters from a filename and returns a safe filename~~.		<i>Normally at the head of the file.<i>

	==Copy a File==		==Copy a File==

Cmb: Corrected the capitalization of JFile.

2019-08-01T21:32:18Z

Corrected the capitalization of JFile.

← Older revision		Revision as of 21:32, 1 August 2019
Line 1:		Line 1:
	{{version\|1.5,2.5,3.x}}		{{version\|1.5,2.5,3.x}}
	=Using the ~~JFILE~~:: class=		=Using the JFile:: class=

	There are 4 classes in the filesystem library.		There are 4 classes in the filesystem library.

Cmb: /* Create Folder */ Added a note about the creation of parent directories and directories that already exist.

2019-07-06T16:28:50Z

Create Folder: Added a note about the creation of parent directories and directories that already exist.

← Older revision		Revision as of 16:28, 6 July 2019
Line 127:		Line 127:
	</source>		</source>
	This is basically a wrapper for the PHP ''mkdir()'' function, but with error permissions and availability checking. This one also uses the FTP-layer when set in the configuration. ''$mode'' will set the default permission, once copied and defaults to 0755.		This is basically a wrapper for the PHP ''mkdir()'' function, but with error permissions and availability checking. This one also uses the FTP-layer when set in the configuration. ''$mode'' will set the default permission, once copied and defaults to 0755.

			If any ''parent'' directory does not exist, it is created. If the directory to be created ($path) already exists, this function just returns a Boolean true.

	==Move folder==		==Move folder==

Cmb: Corrected the location of the File.php and the Folder.php files.

2019-06-27T19:54:23Z

Corrected the location of the File.php and the Folder.php files.

← Older revision		Revision as of 19:54, 27 June 2019
Line 11:		Line 11:
	This tutorial focuses on the JFile:: and JFolder:: classes.		This tutorial focuses on the JFile:: and JFolder:: classes.

	The base for file handling is the JFile class, found in ''libraries/~~joomla~~/~~filesystem~~/~~file~~.php'' file.		The base for file handling is the JFile class, found in the ''/libraries/src/Filesystem/File.php'' file.
	Below you can see the most common options from this library file. At the end of this post you can find a very simple script for file upload.		Below you can see the most common options from this library file. At the end of this post you can find a very simple script for file upload.

Line 111:		Line 111:

	=Using the JFolder:: Class=		=Using the JFolder:: Class=
	The base for folder handling is the JFolder class, found in ''libraries/~~joomla~~/~~filesystem~~/~~folder~~.php'' file.		The base for folder handling is the JFolder class, found in the ''/libraries/src/Filesystem/Folder.php'' file.
	Below I will discuss the most common options from this library file. At the end there is a simple example script.		Below I will discuss the most common options from this library file. At the end there is a simple example script.

Cmb: Several spelling, punctuation and grammar corrections.

2019-06-27T17:13:29Z

Several spelling, punctuation and grammar corrections.

Show changes

Tonypartridge: Space should follow after //

2017-08-23T14:18:03Z

Space should follow after //

← Older revision		Revision as of 14:18, 23 August 2017
Line 77:		Line 77:
	* File upload example		* File upload example
	*/		*/
	//Retrieve file details from uploaded file, sent from upload form		// Retrieve file details from uploaded file, sent from upload form
	$file = JFactory::getApplication()->input->get('file_upload');		$file = JFactory::getApplication()->input->get('file_upload');

	//Import filesystem libraries. Perhaps not necessary, but does not hurt		// Import filesystem libraries. Perhaps not necessary, but does not hurt
	jimport('joomla.filesystem.file');		jimport('joomla.filesystem.file');

	//Clean up filename to get rid of strange characters like spaces etc		// Clean up filename to get rid of strange characters like spaces etc
	$filename = JFile::makeSafe($file['name']);		$filename = JFile::makeSafe($file['name']);

	//Set up the source and destination of the file		// Set up the source and destination of the file
	$src = $file['tmp_name'];		$src = $file['tmp_name'];
	$dest = JPATH_COMPONENT . DS . "uploads" . DS . $filename;		$dest = JPATH_COMPONENT . DS . "uploads" . DS . $filename;

	//First check if the file has the right extension, we need jpg only		// First check if the file has the right extension, we need jpg only
	if (strtolower(JFile::getExt($filename)) == 'jpg')		if (strtolower(JFile::getExt($filename)) == 'jpg')
	{		{
Line 97:		Line 97:
	if (JFile::upload($src, $dest))		if (JFile::upload($src, $dest))
	{		{
	//Redirect to a page of your choice		// Redirect to a page of your choice
	}		}
	else		else
	{		{
	//Redirect and throw an error message		// Redirect and throw an error message
	}		}
	}		}
	else		else
	{		{
	//Redirect and notify user file is not right extension		// Redirect and notify user file is not right extension
	}		}
	?>		?>
Line 228:		Line 228:
	}		}

	//Lastly, we are moving the complete subdir to the root of the component.		// Lastly, we are moving the complete subdir to the root of the component.
	if (JFolder::move($searchpath . '/'. 'jpg', JPATH_COMPONENT))		if (JFolder::move($searchpath . '/'. 'jpg', JPATH_COMPONENT))
	{		{
	//Redirect with perhaps a happy message		// Redirect with perhaps a happy message
	}		}
	else		else
	{		{
	//Throw an error		// Throw an error
	}		}
	?>		?>

Yvesh: Cleanup, J3.x and trying to remove the most worse codestyle and security issues.. WIP -- 2017-03-12

2017-03-12T11:42:06Z

Cleanup, J3.x and trying to remove the most worse codestyle and security issues.. WIP -- 2017-03-12

Show changes

Harris ingram at 00:30, 29 July 2016

2016-07-29T00:30:55Z

← Older revision		Revision as of 00:30, 29 July 2016
Line 337:		Line 337:
	//First we set up parameters		//First we set up parameters
	$searchpath = JPATH_COMPONENT . DS . "images";		$searchpath = JPATH_COMPONENT . DS . "images";
			//Import the folder system library
			jimport('joomla.filesystem.folder');
	//Then we create the subfolder called jpg		//Then we create the subfolder called jpg
	if ( !JFolder::create($searchpath . DS . "jpg") ) {		if ( !JFolder::create($searchpath . DS . "jpg") ) {

Wilsonge: This tutorial doesn't apply to 3.x (uses in xml and use of DS constant)

2013-04-29T09:39:47Z

This tutorial doesn't apply to 3.x (uses <install> in xml and use of DS constant)

← Older revision		Revision as of 09:39, 29 April 2013
Line 1:		Line 1:
	{{version\|1.5,2.5~~,3.1~~}}		{{version\|1.5,2.5}}
	=Using the JFILE:: class=		=Using the JFILE:: class=