Joomla! Documentation - User contributions [en]

API16:JFolder/create

2011-10-01T07:36:21Z

Ravenheart: /* Examples */

===Description===
Create a folder -- and all necessary parent folders.


<nowiki>[</nowiki>[[Description:JFolder/create|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFolder/create}}

===Syntax===
<source lang="php">create($path= '', $mode=0755)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
| ''
| A path to create from the base path.
|-
| $mode
| 0755
| Directory permissions to set for folders created.
|}

===Returns===
boolean True if successful.

===Defined in===
libraries/joomla/filesystem/folder.php
===Importing===
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>

===Source Body===
<source lang="php">
function create($path = '', $mode = 0755)
{
// Initialise variables.
jimport('joomla.client.helper');
$FTPOptions = JClientHelper::getCredentials('ftp');
static $nested = 0;

// Check to make sure the path valid and clean
$path = JPath::clean($path);

// Check if parent dir exists
$parent = dirname($path);
if (!JFolder::exists($parent)) {
// Prevent infinite loops!
$nested++;
if (($nested > 20) || ($parent == $path)) {
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Infinite loop detected')
);
$nested--;
return false;
}

// Create the parent directory
if (JFolder::create($parent, $mode) !== true) {
// JFolder::create throws an error
$nested--;
return false;
}

// OK, parent directory has been created
$nested--;
}

// Check if dir already exists
if (JFolder::exists($path)) {
return true;
}

// Check for safe mode
if ($FTPOptions['enabled'] == 1) {
// Connect the FTP client
jimport('joomla.client.ftp');
$ftp = &JFTP::getInstance(
$FTPOptions['host'], $FTPOptions['port'], null,
$FTPOptions['user'], $FTPOptions['pass']
);

// Translate path to FTP path
$path = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $path), '/');
$ret = $ftp->mkdir($path);
$ftp->chmod($path, $mode);
} else {
// We need to get and explode the open_basedir paths
$obd = ini_get('open_basedir');

// If open_basedir is set we need to get the open_basedir that the path is in
if ($obd != null)
{
if (JPATH_ISWIN) {
$obdSeparator = ";";
} else {
$obdSeparator = ":";
}
// Create the array of open_basedir paths
$obdArray = explode($obdSeparator, $obd);
$inBaseDir = false;
// Iterate through open_basedir paths looking for a match
foreach ($obdArray as $test) {
$test = JPath::clean($test);
if (strpos($path, $test) === 0) {
$obdpath = $test;
$inBaseDir = true;
break;
}
}
if ($inBaseDir == false) {
// Return false for JFolder::create because the path to be created is not in open_basedir
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Path not in open_basedir paths')
);
return false;
}
}

// First set umask
$origmask = @umask(0);

// Create the path
if (!$ret = @mkdir($path, $mode)) {
@umask($origmask);
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('COULD_NOT_CREATE_DIRECTORY'),
'Path: ' . $path
);
return false;
}

// Reset umask
@umask($origmask);
}
return $ret;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFolder/create|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFolder/create}}

===Examples===
To create a subfolder(in this example: photoalbum) to images, write:
<source lang="php">
JFolder::create("images".DS."photoalbum");
</source>
As long as you execute this from the frontend your fine. If you like to make sure the folders are created under the site section regardless of where the command is executed, write:
<source lang="php">
JFolder::create(JPATH_SITE.DS."your path here");
</source>
For always under /administrator, write;
<source lang="php">
JFolder::create(JPATH_ADMINISTRATOR.DS."your path here");
</source>

API16:JFolder/create

2011-09-30T17:29:40Z

Ravenheart: /* Examples */

===Description===
Create a folder -- and all necessary parent folders.


<nowiki>[</nowiki>[[Description:JFolder/create|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFolder/create}}

===Syntax===
<source lang="php">create($path= '', $mode=0755)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
| ''
| A path to create from the base path.
|-
| $mode
| 0755
| Directory permissions to set for folders created.
|}

===Returns===
boolean True if successful.

===Defined in===
libraries/joomla/filesystem/folder.php
===Importing===
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>

===Source Body===
<source lang="php">
function create($path = '', $mode = 0755)
{
// Initialise variables.
jimport('joomla.client.helper');
$FTPOptions = JClientHelper::getCredentials('ftp');
static $nested = 0;

// Check to make sure the path valid and clean
$path = JPath::clean($path);

// Check if parent dir exists
$parent = dirname($path);
if (!JFolder::exists($parent)) {
// Prevent infinite loops!
$nested++;
if (($nested > 20) || ($parent == $path)) {
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Infinite loop detected')
);
$nested--;
return false;
}

// Create the parent directory
if (JFolder::create($parent, $mode) !== true) {
// JFolder::create throws an error
$nested--;
return false;
}

// OK, parent directory has been created
$nested--;
}

// Check if dir already exists
if (JFolder::exists($path)) {
return true;
}

// Check for safe mode
if ($FTPOptions['enabled'] == 1) {
// Connect the FTP client
jimport('joomla.client.ftp');
$ftp = &JFTP::getInstance(
$FTPOptions['host'], $FTPOptions['port'], null,
$FTPOptions['user'], $FTPOptions['pass']
);

// Translate path to FTP path
$path = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $path), '/');
$ret = $ftp->mkdir($path);
$ftp->chmod($path, $mode);
} else {
// We need to get and explode the open_basedir paths
$obd = ini_get('open_basedir');

// If open_basedir is set we need to get the open_basedir that the path is in
if ($obd != null)
{
if (JPATH_ISWIN) {
$obdSeparator = ";";
} else {
$obdSeparator = ":";
}
// Create the array of open_basedir paths
$obdArray = explode($obdSeparator, $obd);
$inBaseDir = false;
// Iterate through open_basedir paths looking for a match
foreach ($obdArray as $test) {
$test = JPath::clean($test);
if (strpos($path, $test) === 0) {
$obdpath = $test;
$inBaseDir = true;
break;
}
}
if ($inBaseDir == false) {
// Return false for JFolder::create because the path to be created is not in open_basedir
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Path not in open_basedir paths')
);
return false;
}
}

// First set umask
$origmask = @umask(0);

// Create the path
if (!$ret = @mkdir($path, $mode)) {
@umask($origmask);
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('COULD_NOT_CREATE_DIRECTORY'),
'Path: ' . $path
);
return false;
}

// Reset umask
@umask($origmask);
}
return $ret;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFolder/create|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFolder/create}}

===Examples===
To create a subfolder(in this example: photoalbum) to images, write:
<source lang="php">
JFolder::create("images.DS.photoalbum");
</source>
As long as you execute this from the frontend your fine. If you like to make sure the folders are created under the site section regardless of where the command is executed, write:
<source lang="php">
JFolder::create(JPATH_SITE.DS."your path here");
</source>
For always under /administrator, write;
<source lang="php">
JFolder::create(JPATH_ADMINISTRATOR.DS."your path here");
</source>

API16:JFolder/create

2011-09-30T16:20:19Z

Ravenheart: /* Examples */

===Description===
Create a folder -- and all necessary parent folders.


<nowiki>[</nowiki>[[Description:JFolder/create|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFolder/create}}

===Syntax===
<source lang="php">create($path= '', $mode=0755)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
| ''
| A path to create from the base path.
|-
| $mode
| 0755
| Directory permissions to set for folders created.
|}

===Returns===
boolean True if successful.

===Defined in===
libraries/joomla/filesystem/folder.php
===Importing===
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>

===Source Body===
<source lang="php">
function create($path = '', $mode = 0755)
{
// Initialise variables.
jimport('joomla.client.helper');
$FTPOptions = JClientHelper::getCredentials('ftp');
static $nested = 0;

// Check to make sure the path valid and clean
$path = JPath::clean($path);

// Check if parent dir exists
$parent = dirname($path);
if (!JFolder::exists($parent)) {
// Prevent infinite loops!
$nested++;
if (($nested > 20) || ($parent == $path)) {
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Infinite loop detected')
);
$nested--;
return false;
}

// Create the parent directory
if (JFolder::create($parent, $mode) !== true) {
// JFolder::create throws an error
$nested--;
return false;
}

// OK, parent directory has been created
$nested--;
}

// Check if dir already exists
if (JFolder::exists($path)) {
return true;
}

// Check for safe mode
if ($FTPOptions['enabled'] == 1) {
// Connect the FTP client
jimport('joomla.client.ftp');
$ftp = &JFTP::getInstance(
$FTPOptions['host'], $FTPOptions['port'], null,
$FTPOptions['user'], $FTPOptions['pass']
);

// Translate path to FTP path
$path = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $path), '/');
$ret = $ftp->mkdir($path);
$ftp->chmod($path, $mode);
} else {
// We need to get and explode the open_basedir paths
$obd = ini_get('open_basedir');

// If open_basedir is set we need to get the open_basedir that the path is in
if ($obd != null)
{
if (JPATH_ISWIN) {
$obdSeparator = ";";
} else {
$obdSeparator = ":";
}
// Create the array of open_basedir paths
$obdArray = explode($obdSeparator, $obd);
$inBaseDir = false;
// Iterate through open_basedir paths looking for a match
foreach ($obdArray as $test) {
$test = JPath::clean($test);
if (strpos($path, $test) === 0) {
$obdpath = $test;
$inBaseDir = true;
break;
}
}
if ($inBaseDir == false) {
// Return false for JFolder::create because the path to be created is not in open_basedir
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Path not in open_basedir paths')
);
return false;
}
}

// First set umask
$origmask = @umask(0);

// Create the path
if (!$ret = @mkdir($path, $mode)) {
@umask($origmask);
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('COULD_NOT_CREATE_DIRECTORY'),
'Path: ' . $path
);
return false;
}

// Reset umask
@umask($origmask);
}
return $ret;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFolder/create|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFolder/create}}

===Examples===
<source lang="php">
JFolder::create("images/photoalbum");
</source>

API16:JFolder/exists

2011-09-30T16:17:22Z

Ravenheart: /* Examples */

===Description===
Wrapper for the standard file_exists function


<nowiki>[</nowiki>[[Description:JFolder/exists|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFolder/exists}}

===Syntax===
<source lang="php">static exists($path)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
|
| Folder name relative to installation dir
|}

===Returns===
boolean True if path is a folder

===Defined in===
libraries/joomla/filesystem/folder.php
===Importing===
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>

===Source Body===
<source lang="php">
public static function exists($path)
{
return is_dir(JPath::clean($path));
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFolder/exists|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFolder/exists}}

===Examples===
<source lang="php">
JFolder::exists("images/banners");
</source>

API16:JFolder/create

2011-09-30T12:01:26Z

Ravenheart: /* Examples */

===Description===
Create a folder -- and all necessary parent folders.


<nowiki>[</nowiki>[[Description:JFolder/create|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JFolder/create}}

===Syntax===
<source lang="php">create($path= '', $mode=0755)</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $path
| ''
| A path to create from the base path.
|-
| $mode
| 0755
| Directory permissions to set for folders created.
|}

===Returns===
boolean True if successful.

===Defined in===
libraries/joomla/filesystem/folder.php
===Importing===
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>

===Source Body===
<source lang="php">
function create($path = '', $mode = 0755)
{
// Initialise variables.
jimport('joomla.client.helper');
$FTPOptions = JClientHelper::getCredentials('ftp');
static $nested = 0;

// Check to make sure the path valid and clean
$path = JPath::clean($path);

// Check if parent dir exists
$parent = dirname($path);
if (!JFolder::exists($parent)) {
// Prevent infinite loops!
$nested++;
if (($nested > 20) || ($parent == $path)) {
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Infinite loop detected')
);
$nested--;
return false;
}

// Create the parent directory
if (JFolder::create($parent, $mode) !== true) {
// JFolder::create throws an error
$nested--;
return false;
}

// OK, parent directory has been created
$nested--;
}

// Check if dir already exists
if (JFolder::exists($path)) {
return true;
}

// Check for safe mode
if ($FTPOptions['enabled'] == 1) {
// Connect the FTP client
jimport('joomla.client.ftp');
$ftp = &JFTP::getInstance(
$FTPOptions['host'], $FTPOptions['port'], null,
$FTPOptions['user'], $FTPOptions['pass']
);

// Translate path to FTP path
$path = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $path), '/');
$ret = $ftp->mkdir($path);
$ftp->chmod($path, $mode);
} else {
// We need to get and explode the open_basedir paths
$obd = ini_get('open_basedir');

// If open_basedir is set we need to get the open_basedir that the path is in
if ($obd != null)
{
if (JPATH_ISWIN) {
$obdSeparator = ";";
} else {
$obdSeparator = ":";
}
// Create the array of open_basedir paths
$obdArray = explode($obdSeparator, $obd);
$inBaseDir = false;
// Iterate through open_basedir paths looking for a match
foreach ($obdArray as $test) {
$test = JPath::clean($test);
if (strpos($path, $test) === 0) {
$obdpath = $test;
$inBaseDir = true;
break;
}
}
if ($inBaseDir == false) {
// Return false for JFolder::create because the path to be created is not in open_basedir
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('Path not in open_basedir paths')
);
return false;
}
}

// First set umask
$origmask = @umask(0);

// Create the path
if (!$ret = @mkdir($path, $mode)) {
@umask($origmask);
JError::raiseWarning(
'SOME_ERROR_CODE',
'JFolder::create: ' . JText::_('COULD_NOT_CREATE_DIRECTORY'),
'Path: ' . $path
);
return false;
}

// Reset umask
@umask($origmask);
}
return $ret;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JFolder/create|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JFolder/create}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=create
category=JFolder
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>
<source lang="php">
JFolder::create("images/photoalbum");
</source>

Archived talk:Developing a MVC Component/Adding verifications

2011-06-18T14:57:50Z

Ravenheart: /* Attention */ new section

Why is the protected function _populateState() in the /admin/models/helloworld.php file? It doesn't appear in the original helloworld.php model file, and there isn't any indication as to the purpose of this function aside from the annotations within the function, which I don't fully understand.

== Attention ==

Section about admin/views/helloworld/tmpl/edit.php is not the same as in file present in archive.

Archived talk:Developing a MVC Component/Adding backend actions

2011-06-18T14:47:40Z

Ravenheart: /* Attention! */

It's not clear to me where the word "helloworld" refers to in these examples. Can you please clarify when 'helloworld' refers to the component,controller,model,table,view or form? While following this, I've changed the name of my component, and when running this I get a 'call to member function getTable() on non-object'. It seems that I used the wrong name somewhere, but I have no idea where.

We're also introducing JForms and JFields. These are powerful and important, and warrant some richer explanation.

== Attention! ==

There is a change in /admin/views/helloworlds/tmpl/default_body.php that isnt mentioned on this page but is present in the archive file.

Archived talk:Developing a MVC Component/Adding backend actions

2011-06-18T14:47:11Z

Ravenheart: /* Attention! */ new section

It's not clear to me where the word "helloworld" refers to in these examples. Can you please clarify when 'helloworld' refers to the component,controller,model,table,view or form? While following this, I've changed the name of my component, and when running this I get a 'call to member function getTable() on non-object'. It seems that I used the wrong name somewhere, but I have no idea where.

We're also introducing JForms and JFields. These are powerful and important, and warrant some richer explanation.

== Attention! ==

There is a change /admin/views/helloworlds/tmpl/default_body.php that isnt mentioned on this page but is present in the archive file.