<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13174] trunk: Introduce two new functions to list files into the BP Attachments API</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13174">13174</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13174","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-12-11 09:40:29 +0000 (Sat, 11 Dec 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Introduce two new functions to list files into the BP Attachments API
- `bp_attachments_list_directory_files()` returns a list of file objects contained into the directory thanks to its absolute path passed as the function argument.
- `bp_attachments_list_directory_files_recursively()` returns a list of file objects contained into the directory and its subdirectories thanks to the directory absolute path passed as the function argument.
Props vapvarun, oztaser
See <a href="http://buddypress.trac.wordpress.org/ticket/8581">#8581</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreattachmentsphp">trunk/src/bp-core/bp-core-attachments.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestcasescoreattachmentsphp">trunk/tests/phpunit/testcases/core/attachments.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreattachmentsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-attachments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-attachments.php 2021-12-10 23:17:02 UTC (rev 13173)
+++ trunk/src/bp-core/bp-core-attachments.php 2021-12-11 09:40:29 UTC (rev 13174)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1597,3 +1597,90 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_ajax_bp_cover_image_delete', 'bp_attachments_cover_image_ajax_delete' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * List the files of a directory.
+ *
+ * @since 10.0.0
+ *
+ * @param string $directory_path Absolute path of a directory.
+ * @return array The file objects list of the directory.
+ */
+function bp_attachments_list_directory_files( $directory_path = '' ) {
+ if ( ! is_dir( $directory_path ) ) {
+ return array();
+ }
+
+ $files = array();
+ $iterator = new FilesystemIterator( $directory_path, FilesystemIterator::SKIP_DOTS );
+
+ foreach ( $iterator as $file ) {
+ $_file = new stdClass();
+
+ $_file->name = $file->getfilename();
+ $_file->path = $file->getPathname();
+ $_file->size = $file->getSize();
+ $_file->type = $file->getType();
+ $_file->mime_type = mime_content_type( $_file->path );
+ $_file->last_modified = $file->getMTime();
+ $_file->latest_access_date = $file->getATime();
+ $_file->id = pathinfo( $_file->name, PATHINFO_FILENAME );
+ $files[ $_file->id ] = $_file;
+ }
+
+ return $files;
+}
+
+/**
+ * List the files of a directory recursively and eventually find a file using its ID.
+ *
+ * @since 10.0.0
+ *
+ * @param string $directory_path Absolute path of a directory.
+ * @param string $find The file ID to find into the directory or its children.
+ * @return array The file objects list of the directory and subdirectories.
+ */
+function bp_attachments_list_directory_files_recursively( $directory_path = '', $find = '' ) {
+ if ( ! is_dir( $directory_path ) ) {
+ return array();
+ }
+
+ $files = array();
+ $directory = new RecursiveDirectoryIterator( $directory_path, FilesystemIterator::SKIP_DOTS );
+ $iterator = new RecursiveIteratorIterator( $directory, RecursiveIteratorIterator::CHILD_FIRST );
+ $bp_upload = bp_upload_dir();
+ $basedir = str_replace( '\\', '/', $bp_upload['basedir'] );
+
+ foreach ( $iterator as $file ) {
+ $_file = new stdClass();
+
+ $_file->name = $file->getfilename();
+ $_file->path = $file->getPathname();
+ $_file->size = $file->getSize();
+ $_file->type = $file->getType();
+ $_file->mime_type = mime_content_type( $_file->path );
+ $_file->last_modified = $file->getMTime();
+ $_file->latest_access_date = $file->getATime();
+ $_file->parent_dir_path = str_replace( '\\', '/', dirname( $_file->path ) );
+ $_file->parent_dir_url = str_replace( $basedir, $bp_upload['baseurl'], $_file->parent_dir_path );
+ $_file->id = pathinfo( $_file->name, PATHINFO_FILENAME );
+
+ // Ensure URL is https if SSL is set/forced.
+ if ( is_ssl() ) {
+ $_file->parent_dir_url = str_replace( 'http://', 'https://', $_file->parent_dir_url );
+ }
+
+ $file_id = $_file->id;
+ if ( $_file->parent_dir_path !== $directory_path ) {
+ $file_id = trailingslashit( str_replace( trailingslashit( $directory_path ), '', $_file->parent_dir_path ) ) . $file_id;
+ }
+
+ $files[ $file_id ] = $_file;
+ }
+
+ if ( $find ) {
+ return wp_filter_object_list( $files, array( 'id' => $find ) );
+ }
+
+ return $files;
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestcasescoreattachmentsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/core/attachments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/attachments.php (rev 0)
+++ trunk/tests/phpunit/testcases/core/attachments.php 2021-12-11 09:40:29 UTC (rev 13174)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,17 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group core
+ */
+
+class BP_Tests_Core_Attachments extends BP_UnitTestCase {
+ /**
+ * @group bp_attachments_list_directory_files_recursively
+ */
+ public function test_bp_attachments_list_directory_files_recursively() {
+ $files = bp_attachments_list_directory_files_recursively( BP_TESTS_DIR . 'assets', 'index' );
+
+ $this->assertTrue( 1 === count( $files ) );
+ $this->assertTrue( isset( $files['templates/index'] ) );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/testcases/core/attachments.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>