summaryrefslogtreecommitdiffstats
path: root/vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md
diff options
context:
space:
mode:
authorStefan Suhren <suhren.stefan@fh-swf.de>2015-05-05 19:34:39 +0200
committerStefan Suhren <suhren.stefan@fh-swf.de>2015-05-05 19:34:39 +0200
commit705c4cb50eea66585cc95c7314001fce9dd197cd (patch)
tree4a448f4e30b117e12306b643121f49da15e6376b /vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md
downloadCatalog-705c4cb50eea66585cc95c7314001fce9dd197cd.tar.gz
Catalog-705c4cb50eea66585cc95c7314001fce9dd197cd.zip
Initial commit
Diffstat (limited to 'vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md')
-rw-r--r--vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md b/vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md
new file mode 100644
index 0000000..df09f93
--- /dev/null
+++ b/vendor/symfony/filesystem/Symfony/Component/Filesystem/README.md
@@ -0,0 +1,47 @@
+Filesystem Component
+====================
+
+Filesystem provides basic utility to manipulate the file system:
+
+```php
+<?php
+
+use Symfony\Component\Filesystem\Filesystem;
+
+$filesystem = new Filesystem();
+
+$filesystem->copy($originFile, $targetFile, $override = false);
+
+$filesystem->mkdir($dirs, $mode = 0777);
+
+$filesystem->touch($files, $time = null, $atime = null);
+
+$filesystem->remove($files);
+
+$filesystem->exists($files);
+
+$filesystem->chmod($files, $mode, $umask = 0000, $recursive = false);
+
+$filesystem->chown($files, $user, $recursive = false);
+
+$filesystem->chgrp($files, $group, $recursive = false);
+
+$filesystem->rename($origin, $target);
+
+$filesystem->symlink($originDir, $targetDir, $copyOnWindows = false);
+
+$filesystem->makePathRelative($endPath, $startPath);
+
+$filesystem->mirror($originDir, $targetDir, \Traversable $iterator = null, $options = array());
+
+$filesystem->isAbsolutePath($file);
+```
+
+Resources
+---------
+
+You can run the unit tests with the following command:
+
+ $ cd path/to/Symfony/Component/Filesystem/
+ $ composer install
+ $ phpunit