80 lines
1.8 KiB
PHP
80 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* Abstract class for a file.
|
|
*
|
|
* @author Time.ly Network Inc.
|
|
* @since 2.0
|
|
*
|
|
* @package AI1EC
|
|
* @subpackage AI1EC.Theme.File
|
|
*/
|
|
abstract class Ai1ec_File_Abstract extends Ai1ec_Base {
|
|
|
|
/**
|
|
* @var array The paths where to look for the file.
|
|
*/
|
|
protected $_paths;
|
|
|
|
/**
|
|
* @var string The name of the file.
|
|
*/
|
|
protected $_name;
|
|
|
|
/**
|
|
* @var mixed The content of the file.
|
|
* Usually it's a string but for some edge cases it might be a PHP type like an array
|
|
* The only case now is user_variables.php for Less
|
|
*/
|
|
protected $_content;
|
|
|
|
/**
|
|
* Locates the file and parses its content. Populates $this->_content.
|
|
*
|
|
* @return boolean Returns true if the file is found, false otheriwse.
|
|
*/
|
|
abstract public function process_file();
|
|
|
|
/**
|
|
* Standard constructor for basic files.
|
|
*
|
|
* @param Ai1ec_Registry_Object $registry
|
|
* @param string $name
|
|
* @param array $paths
|
|
*/
|
|
public function __construct(
|
|
Ai1ec_Registry_Object $registry,
|
|
$name,
|
|
array $paths
|
|
) {
|
|
parent::__construct( $registry );
|
|
$this->_paths = $paths;
|
|
$this->_name = $name;
|
|
}
|
|
|
|
/**
|
|
* Renders the content of the file to the screen.
|
|
*/
|
|
public function render() {
|
|
echo $this->_content;
|
|
}
|
|
|
|
|
|
/**
|
|
* @param bool $mute_output used for compatibility reason with old code.
|
|
*
|
|
* @return mixed the parsed content of the file.
|
|
*/
|
|
public function get_content( $mute_output = false ) {
|
|
if ( true === $mute_output ) {
|
|
return '';
|
|
}
|
|
return $this->_content;
|
|
}
|
|
|
|
/**
|
|
* Just in case you want to echo the object.
|
|
*/
|
|
public function __toString() {
|
|
return $this->_content;
|
|
}
|
|
}
|