Class MyFiles

Folder

MyFiles

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

MyFiles This class supports the assignment of rights to every folder of adm_my_files It's easy to create new folders and get detailed error messages if there are problems with folder rights

Beside the methods of the parent class there are the following additional methods:

checkSettings() - method checks if adm_my_files folder has all necessary rights getServerPath() - returns the current path setSubFolder($folder) - open a folder in the current module folder if that folder doesn't exists than it will be created

Located at myfiles.php

Methods summary

`public`	# `__construct( string $module )` module name should be the folder name in adm_my_files for this module Example: 'PHOTOS', 'BACKUP', 'DOWNLOAD' module name should be the folder name in adm_my_files for this module Example: 'PHOTOS', 'BACKUP', 'DOWNLOAD' Parameters `$module` Overrides `Folder::__construct`
`public boolean`	# `checkSettings( )` method checks if adm_my_files folder has all necessary rights the method is designed to make as little as possible checks method checks if adm_my_files folder has all necessary rights the method is designed to make as little as possible checks [1] (!@mkdir($dirPath, 0777) && !is_dir($dirPath)) This issue is difficult to reproduce, as any of concurrency-related issues. Appears when several processes attempting to create a directory which is not yet existing, but between is_dir() and mkdir() calls another process already managed to create a directory. Returns boolean if false than check the parameters $errorText, $errorPath
`public string`	# `getServerPath( )` Returns string returns the current path
`public boolean`	# `setSubFolder( string $folder )` open a folder in the current module folder if that folder doesn't exists than it will be created open a folder in the current module folder if that folder doesn't exists than it will be created [1] (!@mkdir($dirPath, 0777) && !is_dir($dirPath)) This issue is difficult to reproduce, as any of concurrency-related issues. Appears when several processes attempting to create a directory which is not yet existing, but between is_dir() and mkdir() calls another process already managed to create a directory. Parameters `$folder` subfolder name Returns boolean Returns true if folder is successfully created and writable.

Methods inherited from Folder

copy(), createFolder(), delete(), getFolder(), move(), rename(), setFolder()

Properties summary

`protected`	`$module`	#
`protected`	`$modulePath`	#
`protected`	`$currentPath`	#
`protected`	`$webPath`	#
`public`	`$errorText`	#
`public`	`$errorPath`	#

Properties inherited from Folder

$folderWithPath

Packages

Classes

Exceptions

Functions

Class MyFiles

Methods summary

Parameters

Overrides

Returns

Returns

Parameters

Returns

Methods inherited from Folder

Properties summary

Properties inherited from Folder