%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace Depicter\Front;
use Averta\Core\Utility\Arr;
use Averta\WordPress\Cache\WPCache;
use Averta\WordPress\Utility\JSON;
use Depicter\Exception\DocumentNotPublished;
use Depicter\Utility\Sanitize;
class Render
{
/**
* @var WPCache
*/
private $cache;
public function __construct(){
$this->cache = \Depicter::cache('document');
}
/**
* Retrieves or renders a document markup
*
* @param int|string $documentID Document ID or alias
* @param array $args Retrieve params
*
* @return string|void
*/
public function document( $documentID = 0, $args = [] ){
$isPrivilegedUser = \Depicter::authorization()->currentUserCanPublishDocument();
$args = Arr::merge( $args, [
'loadStyleMode' => 'auto',// ["auto", "inline", "file"]."auto" loads custom css if available, otherwise prints styles inline
'useCache' => true,
'echo' => true,
'status' => 'publish',
'showAdminNotice' => $isPrivilegedUser
]);
if ( $args['isPrivilegedUser'] = $isPrivilegedUser ) {
$args['status'] = ['publish', 'draft', 'future'];
$args['useCache'] = false;
$args['loadStyleMode'] = 'inline';
}
$output = $this->getDocument( $documentID, $args ); // retrieves escaped slider markup
if ( !empty( $output ) ) {
// Fallback to load missing asset files of a document
\Depicter::front()->assets()->enqueueAssets( $documentID, $isPrivilegedUser );
}
if( $args['echo'] ){
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return $output;
}
}
/**
* Retrieves a document markup
*
* @param int|string $documentID Document ID or alias
* @param array $args Retrieve params
*
* @return string
*/
protected function getDocument( $documentID = '', $args = [] )
{
if ( empty( $documentID ) ) {
return esc_html__( 'Slider ID is required.', 'depicter' );
}
if( ! \Depicter::document()->displayRules( $documentID )->isVisible( $args ) ){
return '';
}
if( $args['useCache'] && ( false !== $cacheOutput = $this->getDocumentCache( $documentID, $args ) ) ){
return $cacheOutput;
}
$output = '';
$where = [ 'status' => $args['status'] ];
$styleGeneratorArgs = isset( $args['addImportant'] ) ? [ 'addImportant' => $args['addImportant'] ] : [];
try{
if( ! $documentID = \Depicter::document()->getID( $documentID ) ){
return esc_html__( 'Slider alias not found.', 'depicter' );
}
if( ! $args['showAdminNotice'] && ! \Depicter::document()->repository()->isPublishedBefore( $documentID ) ) {
throw new DocumentNotPublished( __( 'Slider is not published yet and saved as "draft"', 'depicter' ), 0, $where );
}
if( $documentModel = \Depicter::document()->getModel( $documentID, $where ) ){
$documentModel->setShowAdminNotice( $args['showAdminNotice'] );
$output .= $documentModel->prepare()->render();
$documentModel->styleGenerator( $styleGeneratorArgs );
if( $args['isPrivilegedUser'] && \Depicter::document()->repository()->isPublished( $documentID ) ){
$documentModel->saveCss();
}
if( ( $args['loadStyleMode'] == 'inline' ) ){
$output = $documentModel->getInlineCssTag() . $output;
// fallback to inline if css file cannot be generated
} elseif( in_array( $args['loadStyleMode'], [ 'auto', 'file' ] ) ) {
if( ! $documentModel->getCssFileUrl() ){
$output = $documentModel->getInlineCssTag() . $output;
}
}
$output = $documentModel->getBeforeInitCssAndTag() . $output;
//----------
$cssLinksToEnqueue = $documentModel->getCustomCssFiles( 'all' );
$this->cache->set( $documentID . '_css_files', $cssLinksToEnqueue, WEEK_IN_SECONDS );
if( $firstSection = $documentModel->getSectionNth(1) ){
$preloadTags = $firstSection->getPreloadTags();
$this->cache->set( $documentID . '_preload_tags', $preloadTags, WEEK_IN_SECONDS );
}
// sanitize the output before caching
$output = Sanitize::html( $output, null, 'depicter/output' );
if( $args['useCache'] ){
$this->setDocumentCache( $documentID, $output, $args );
} else {
$this->deleteDocumentCache( $documentID, $args );
}
}
} catch( \Exception $exception ){
$output = Sanitize::html( $exception->getMessage() );
}
return $output;
}
/**
* Retrieves the cached markup and enqueues custom styles
*
* @param int $documentID
* @param array $args
*
* @return bool|mixed
*/
protected function getDocumentCache( $documentID, $args = [] ){
if( ( false !== $cacheOutput = $this->cache->get( $this->getDocumentCacheKey( $documentID, $args ) ) ) && !empty( $cacheOutput ) ){
return $cacheOutput;
}
return false;
}
/**
* Cache markup and styles
*
* @param int $documentID
* @param string $content
* @param array $args
*
* @return bool
*/
protected function setDocumentCache( $documentID, $content, $args = [] ): bool{
return $this->cache->set( $this->getDocumentCacheKey( $documentID, $args ), $content, 4 * DAY_IN_SECONDS );
}
/**
* Flushes a document cache
*
* @param int $documentID
* @param array $args
*
* @return bool
*/
protected function deleteDocumentCache( $documentID, $args = [] ){
return $this->cache->delete( $this->getDocumentCacheKey( $documentID, $args ) );
}
/**
* Flushes entire document cache
*
* @param int $documentID
*/
public function flushDocumentCache( $documentID ){
$this->cache->delete( $documentID ."_auto" );
$this->cache->delete( $documentID ."_inline" );
$this->cache->delete( $documentID ."_css_files" );
}
protected function getDocumentCacheKey( $documentID = '', $args = [] ){
// type of loading style
$loadStyleMode = $args['loadStyleMode'] ?? 'auto';
// whether addImportant option is enabled for styles or not
$addImportant = !empty( $args['addImportant'] ) ? '1' : '0';
// If the cache is for logged-in users or not (visitors)
$cacheFor = !empty( $args['isPrivilegedUser'] ) ? 'admin_' : '';
// Include admin notice in document markup or not
$isAdminNoticeEnabled = !empty( $args['showAdminNotice'] ) ? 'notice_' : '';
// The last modified date of main document
$documentModifiedTime = strtotime( \Depicter::documentRepository()->getFieldValue( $documentID, 'modified_at') );
return "{$documentID}_{$loadStyleMode}_{$cacheFor}{$isAdminNoticeEnabled}{$addImportant}{$documentModifiedTime}";
}
}
Zerion Mini Shell 1.0