id: 53
source: 1
name: includeFile
description: 'Snippet to include files from filesystem'
category: knit
properties: 'a:0:{}'

-----

/**
 * includeFile snippet for knit extra
 *
 * Copyright 2021 by Iris Hammer iris.hammer@justknit.de
 * Created on 08-27-2021
 *
 * knit is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * knit is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * knit; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * @package knit
 */

/**
 * Description
 * -----------
 * Snippet to include files from filesystem
 *
 * Variables
 * ---------
 * @var $modx modX
 * @var $scriptProperties array
 *
 * @package knit
 **/


# Snippet to include files from filesystem
# [[includeFile? &file=`assets/templates/mytemplate/file.html`]]

if ( !isset($file) || $file== "" ) return "No file specified."; //check if there's a file given.

//Start the buffer
ob_start();

//include
include $file;

//get contents from the buffer
$ob_contents = ob_get_contents();

//and kill/delete the buffer
ob_end_clean();

//return it to MODx
return $ob_contents;