123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183 |
- <?php
- /**
- * @package Grav\Common\Page
- *
- * @copyright Copyright (C) 2015 - 2019 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Common\Page;
- use Grav\Common\Cache;
- use Grav\Common\Config\Config;
- use Grav\Common\Data\Blueprint;
- use Grav\Common\File\CompiledYamlFile;
- use Grav\Common\Filesystem\Folder;
- use Grav\Common\Grav;
- use Grav\Common\Markdown\Parsedown;
- use Grav\Common\Markdown\ParsedownExtra;
- use Grav\Common\Page\Interfaces\PageInterface;
- use Grav\Common\Media\Traits\MediaTrait;
- use Grav\Common\Page\Markdown\Excerpts;
- use Grav\Common\Taxonomy;
- use Grav\Common\Uri;
- use Grav\Common\Utils;
- use Grav\Common\Yaml;
- use Negotiation\Accept;
- use Negotiation\Negotiator;
- use RocketTheme\Toolbox\Event\Event;
- use RocketTheme\Toolbox\File\MarkdownFile;
- define('PAGE_ORDER_PREFIX_REGEX', '/^[0-9]+\./u');
- class Page implements PageInterface
- {
- use MediaTrait;
- /**
- * @var string Filename. Leave as null if page is folder.
- */
- protected $name;
- protected $folder;
- protected $path;
- protected $extension;
- protected $url_extension;
- protected $id;
- protected $parent;
- protected $template;
- protected $expires;
- protected $cache_control;
- protected $visible;
- protected $published;
- protected $publish_date;
- protected $unpublish_date;
- protected $slug;
- protected $route;
- protected $raw_route;
- protected $url;
- protected $routes;
- protected $routable;
- protected $modified;
- protected $redirect;
- protected $external_url;
- protected $items;
- protected $header;
- protected $frontmatter;
- protected $language;
- protected $content;
- protected $content_meta;
- protected $summary;
- protected $raw_content;
- protected $pagination;
- protected $metadata;
- protected $title;
- protected $max_count;
- protected $menu;
- protected $date;
- protected $dateformat;
- protected $taxonomy;
- protected $order_by;
- protected $order_dir;
- protected $order_manual;
- protected $modular;
- protected $modular_twig;
- protected $process;
- protected $summary_size;
- protected $markdown_extra;
- protected $etag;
- protected $last_modified;
- protected $home_route;
- protected $hide_home_route;
- protected $ssl;
- protected $template_format;
- protected $debugger;
- /** @var array */
- protected $forms;
- /**
- * @var PageInterface Unmodified (original) version of the page. Used for copying and moving the page.
- */
- private $_original;
- /**
- * @var string Action
- */
- private $_action;
- /**
- * Page Object Constructor
- */
- public function __construct()
- {
- /** @var Config $config */
- $config = Grav::instance()['config'];
- $this->taxonomy = [];
- $this->process = $config->get('system.pages.process');
- $this->published = true;
- }
- /**
- * Initializes the page instance variables based on a file
- *
- * @param \SplFileInfo $file The file information for the .md file that the page represents
- * @param string $extension
- *
- * @return $this
- */
- public function init(\SplFileInfo $file, $extension = null)
- {
- $config = Grav::instance()['config'];
- // some extension logic
- if (empty($extension)) {
- $this->extension('.' . $file->getExtension());
- } else {
- $this->extension($extension);
- }
- // extract page language from page extension
- $language = trim(basename($this->extension(), 'md'), '.') ?: null;
- $this->language($language);
- $this->hide_home_route = $config->get('system.home.hide_in_urls', false);
- $this->home_route = $this->adjustRouteCase($config->get('system.home.alias'));
- $this->filePath($file->getPathname());
- $this->modified($file->getMTime());
- $this->id($this->modified() . md5($this->filePath()));
- $this->routable(true);
- $this->header();
- $this->date();
- $this->metadata();
- $this->url();
- $this->visible();
- $this->modularTwig(strpos($this->slug(), '_') === 0);
- $this->setPublishState();
- $this->published();
- $this->urlExtension();
- return $this;
- }
- protected function processFrontmatter()
- {
- // Quick check for twig output tags in frontmatter if enabled
- $process_fields = (array)$this->header();
- if (Utils::contains(json_encode(array_values($process_fields)), '{{')) {
- $ignored_fields = [];
- foreach ((array)Grav::instance()['config']->get('system.pages.frontmatter.ignore_fields') as $field) {
- if (isset($process_fields[$field])) {
- $ignored_fields[$field] = $process_fields[$field];
- unset($process_fields[$field]);
- }
- }
- $text_header = Grav::instance()['twig']->processString(json_encode($process_fields, JSON_UNESCAPED_UNICODE), ['page' => $this]);
- $this->header((object)(json_decode($text_header, true) + $ignored_fields));
- }
- }
- /**
- * Return an array with the routes of other translated languages
- *
- * @param bool $onlyPublished only return published translations
- *
- * @return array the page translated languages
- */
- public function translatedLanguages($onlyPublished = false)
- {
- $filename = substr($this->name, 0, -(strlen($this->extension())));
- $config = Grav::instance()['config'];
- $languages = $config->get('system.languages.supported', []);
- $translatedLanguages = [];
- foreach ($languages as $language) {
- $path = $this->path . DS . $this->folder . DS . $filename . '.' . $language . '.md';
- if (file_exists($path)) {
- $aPage = new Page();
- $aPage->init(new \SplFileInfo($path), $language . '.md');
- $route = $aPage->header()->routes['default'] ?? $aPage->rawRoute();
- if (!$route) {
- $route = $aPage->route();
- }
- if ($onlyPublished && !$aPage->published()) {
- continue;
- }
- $translatedLanguages[$language] = $route;
- }
- }
- return $translatedLanguages;
- }
- /**
- * Return an array listing untranslated languages available
- *
- * @param bool $includeUnpublished also list unpublished translations
- *
- * @return array the page untranslated languages
- */
- public function untranslatedLanguages($includeUnpublished = false)
- {
- $filename = substr($this->name, 0, -strlen($this->extension()));
- $config = Grav::instance()['config'];
- $languages = $config->get('system.languages.supported', []);
- $untranslatedLanguages = [];
- foreach ($languages as $language) {
- $path = $this->path . DS . $this->folder . DS . $filename . '.' . $language . '.md';
- if (file_exists($path)) {
- $aPage = new Page();
- $aPage->init(new \SplFileInfo($path), $language . '.md');
- if ($includeUnpublished && !$aPage->published()) {
- $untranslatedLanguages[] = $language;
- }
- } else {
- $untranslatedLanguages[] = $language;
- }
- }
- return $untranslatedLanguages;
- }
- /**
- * Gets and Sets the raw data
- *
- * @param string $var Raw content string
- *
- * @return string Raw content string
- */
- public function raw($var = null)
- {
- $file = $this->file();
- if ($var) {
- // First update file object.
- if ($file) {
- $file->raw($var);
- }
- // Reset header and content.
- $this->modified = time();
- $this->id($this->modified() . md5($this->filePath()));
- $this->header = null;
- $this->content = null;
- $this->summary = null;
- }
- return $file ? $file->raw() : '';
- }
- /**
- * Gets and Sets the page frontmatter
- *
- * @param string|null $var
- *
- * @return string
- */
- public function frontmatter($var = null)
- {
- if ($var) {
- $this->frontmatter = (string)$var;
- // Update also file object.
- $file = $this->file();
- if ($file) {
- $file->frontmatter((string)$var);
- }
- // Force content re-processing.
- $this->id(time() . md5($this->filePath()));
- }
- if (!$this->frontmatter) {
- $this->header();
- }
- return $this->frontmatter;
- }
- /**
- * Gets and Sets the header based on the YAML configuration at the top of the .md file
- *
- * @param object|array $var a YAML object representing the configuration for the file
- *
- * @return object the current YAML configuration
- */
- public function header($var = null)
- {
- if ($var) {
- $this->header = (object)$var;
- // Update also file object.
- $file = $this->file();
- if ($file) {
- $file->header((array)$var);
- }
- // Force content re-processing.
- $this->id(time() . md5($this->filePath()));
- }
- if (!$this->header) {
- $file = $this->file();
- if ($file) {
- try {
- $this->raw_content = $file->markdown();
- $this->frontmatter = $file->frontmatter();
- $this->header = (object)$file->header();
- if (!Utils::isAdminPlugin()) {
- // If there's a `frontmatter.yaml` file merge that in with the page header
- // note page's own frontmatter has precedence and will overwrite any defaults
- $frontmatterFile = CompiledYamlFile::instance($this->path . '/' . $this->folder . '/frontmatter.yaml');
- if ($frontmatterFile->exists()) {
- $frontmatter_data = (array)$frontmatterFile->content();
- $this->header = (object)array_replace_recursive($frontmatter_data,
- (array)$this->header);
- $frontmatterFile->free();
- }
- // Process frontmatter with Twig if enabled
- if (Grav::instance()['config']->get('system.pages.frontmatter.process_twig') === true) {
- $this->processFrontmatter();
- }
- }
- } catch (\Exception $e) {
- $file->raw(Grav::instance()['language']->translate([
- 'GRAV.FRONTMATTER_ERROR_PAGE',
- $this->slug(),
- $file->filename(),
- $e->getMessage(),
- $file->raw()
- ]));
- $this->raw_content = $file->markdown();
- $this->frontmatter = $file->frontmatter();
- $this->header = (object)$file->header();
- }
- $var = true;
- }
- }
- if ($var) {
- if (isset($this->header->slug)) {
- $this->slug($this->header->slug);
- }
- if (isset($this->header->routes)) {
- $this->routes = (array)$this->header->routes;
- }
- if (isset($this->header->title)) {
- $this->title = trim($this->header->title);
- }
- if (isset($this->header->language)) {
- $this->language = trim($this->header->language);
- }
- if (isset($this->header->template)) {
- $this->template = trim($this->header->template);
- }
- if (isset($this->header->menu)) {
- $this->menu = trim($this->header->menu);
- }
- if (isset($this->header->routable)) {
- $this->routable = (bool)$this->header->routable;
- }
- if (isset($this->header->visible)) {
- $this->visible = (bool)$this->header->visible;
- }
- if (isset($this->header->redirect)) {
- $this->redirect = trim($this->header->redirect);
- }
- if (isset($this->header->external_url)) {
- $this->external_url = trim($this->header->external_url);
- }
- if (isset($this->header->order_dir)) {
- $this->order_dir = trim($this->header->order_dir);
- }
- if (isset($this->header->order_by)) {
- $this->order_by = trim($this->header->order_by);
- }
- if (isset($this->header->order_manual)) {
- $this->order_manual = (array)$this->header->order_manual;
- }
- if (isset($this->header->dateformat)) {
- $this->dateformat($this->header->dateformat);
- }
- if (isset($this->header->date)) {
- $this->date($this->header->date);
- }
- if (isset($this->header->markdown_extra)) {
- $this->markdown_extra = (bool)$this->header->markdown_extra;
- }
- if (isset($this->header->taxonomy)) {
- $this->taxonomy($this->header->taxonomy);
- }
- if (isset($this->header->max_count)) {
- $this->max_count = (int)$this->header->max_count;
- }
- if (isset($this->header->process)) {
- foreach ((array)$this->header->process as $process => $status) {
- $this->process[$process] = (bool)$status;
- }
- }
- if (isset($this->header->published)) {
- $this->published = (bool)$this->header->published;
- }
- if (isset($this->header->publish_date)) {
- $this->publishDate($this->header->publish_date);
- }
- if (isset($this->header->unpublish_date)) {
- $this->unpublishDate($this->header->unpublish_date);
- }
- if (isset($this->header->expires)) {
- $this->expires = (int)$this->header->expires;
- }
- if (isset($this->header->cache_control)) {
- $this->cache_control = $this->header->cache_control;
- }
- if (isset($this->header->etag)) {
- $this->etag = (bool)$this->header->etag;
- }
- if (isset($this->header->last_modified)) {
- $this->last_modified = (bool)$this->header->last_modified;
- }
- if (isset($this->header->ssl)) {
- $this->ssl = (bool)$this->header->ssl;
- }
- if (isset($this->header->template_format)) {
- $this->template_format = $this->header->template_format;
- }
- if (isset($this->header->debugger)) {
- $this->debugger = (bool)$this->header->debugger;
- }
- if (isset($this->header->append_url_extension)) {
- $this->url_extension = $this->header->append_url_extension;
- }
- }
- return $this->header;
- }
- /**
- * Get page language
- *
- * @param string $var
- *
- * @return mixed
- */
- public function language($var = null)
- {
- if ($var !== null) {
- $this->language = $var;
- }
- return $this->language;
- }
- /**
- * Modify a header value directly
- *
- * @param string $key
- * @param mixed $value
- */
- public function modifyHeader($key, $value)
- {
- $this->header->{$key} = $value;
- }
- /**
- * @return int
- */
- public function httpResponseCode()
- {
- return (int)($this->header()->http_response_code ?? 200);
- }
- public function httpHeaders()
- {
- $headers = [];
- $grav = Grav::instance();
- $format = $this->templateFormat();
- $cache_control = $this->cacheControl();
- $expires = $this->expires();
- // Set Content-Type header
- $headers['Content-Type'] = Utils::getMimeByExtension($format, 'text/html');
- // Calculate Expires Headers if set to > 0
- if ($expires > 0) {
- $expires_date = gmdate('D, d M Y H:i:s', time() + $expires) . ' GMT';
- if (!$cache_control) {
- $headers['Cache-Control'] = 'max-age=' . $expires;
- }
- $headers['Expires'] = $expires_date;
- }
- // Set Cache-Control header
- if ($cache_control) {
- $headers['Cache-Control'] = strtolower($cache_control);
- }
- // Set Last-Modified header
- if ($this->lastModified()) {
- $last_modified_date = gmdate('D, d M Y H:i:s', $this->modified()) . ' GMT';
- $headers['Last-Modified'] = $last_modified_date;
- }
- // Ask Grav to calculate ETag from the final content.
- if ($this->eTag()) {
- $headers['ETag'] = '1';
- }
- // Set Vary: Accept-Encoding header
- if ($grav['config']->get('system.pages.vary_accept_encoding', false)) {
- $headers['Vary'] = 'Accept-Encoding';
- }
- return $headers;
- }
- /**
- * Get the summary.
- *
- * @param int $size Max summary size.
- *
- * @param bool $textOnly Only count text size.
- *
- * @return string
- */
- public function summary($size = null, $textOnly = false)
- {
- $config = (array)Grav::instance()['config']->get('site.summary');
- if (isset($this->header->summary)) {
- $config = array_merge($config, $this->header->summary);
- }
- // Return summary based on settings in site config file
- if (!$config['enabled']) {
- return $this->content();
- }
- // Set up variables to process summary from page or from custom summary
- if ($this->summary === null) {
- $content = $textOnly ? strip_tags($this->content()) : $this->content();
- $summary_size = $this->summary_size;
- } else {
- $content = strip_tags($this->summary);
- // Use mb_strwidth to deal with the 2 character widths characters
- $summary_size = mb_strwidth($content, 'utf-8');
- }
- // Return calculated summary based on summary divider's position
- $format = $config['format'];
- // Return entire page content on wrong/ unknown format
- if (!in_array($format, ['short', 'long'])) {
- return $content;
- }
- if (($format === 'short') && isset($summary_size)) {
- // Use mb_strimwidth to slice the string
- if (mb_strwidth($content, 'utf8') > $summary_size) {
- return mb_substr($content, 0, $summary_size);
- }
- return $content;
- }
- // Get summary size from site config's file
- if ($size === null) {
- $size = $config['size'];
- }
- // If the size is zero, return the entire page content
- if ($size === 0) {
- return $content;
- // Return calculated summary based on defaults
- }
- if (!is_numeric($size) || ($size < 0)) {
- $size = 300;
- }
- // Only return string but not html, wrap whatever html tag you want when using
- if ($textOnly) {
- if (mb_strwidth($content, 'utf-8') <= $size) {
- return $content;
- }
- return mb_strimwidth($content, 0, $size, '…', 'UTF-8');
- }
- $summary = Utils::truncateHtml($content, $size);
- return html_entity_decode($summary, ENT_COMPAT | ENT_HTML401, 'UTF-8');
- }
- /**
- * Sets the summary of the page
- *
- * @param string $summary Summary
- */
- public function setSummary($summary)
- {
- $this->summary = $summary;
- }
- /**
- * Gets and Sets the content based on content portion of the .md file
- *
- * @param string $var Content
- *
- * @return string Content
- */
- public function content($var = null)
- {
- if ($var !== null) {
- $this->raw_content = $var;
- // Update file object.
- $file = $this->file();
- if ($file) {
- $file->markdown($var);
- }
- // Force re-processing.
- $this->id(time() . md5($this->filePath()));
- $this->content = null;
- }
- // If no content, process it
- if ($this->content === null) {
- // Get media
- $this->media();
- /** @var Config $config */
- $config = Grav::instance()['config'];
- // Load cached content
- /** @var Cache $cache */
- $cache = Grav::instance()['cache'];
- $cache_id = md5('page' . $this->getCacheKey());
- $content_obj = $cache->fetch($cache_id);
- if (is_array($content_obj)) {
- $this->content = $content_obj['content'];
- $this->content_meta = $content_obj['content_meta'];
- } else {
- $this->content = $content_obj;
- }
- $process_markdown = $this->shouldProcess('markdown');
- $process_twig = $this->shouldProcess('twig') || $this->modularTwig();
- $cache_enable = $this->header->cache_enable ?? $config->get('system.cache.enabled',
- true);
- $twig_first = $this->header->twig_first ?? $config->get('system.pages.twig_first',
- true);
- // never cache twig means it's always run after content
- $never_cache_twig = $this->header->never_cache_twig ?? $config->get('system.pages.never_cache_twig',
- false);
- // if no cached-content run everything
- if ($never_cache_twig) {
- if ($this->content === false || $cache_enable === false) {
- $this->content = $this->raw_content;
- Grav::instance()->fireEvent('onPageContentRaw', new Event(['page' => $this]));
- if ($process_markdown) {
- $this->processMarkdown();
- }
- // Content Processed but not cached yet
- Grav::instance()->fireEvent('onPageContentProcessed', new Event(['page' => $this]));
- if ($cache_enable) {
- $this->cachePageContent();
- }
- }
- if ($process_twig) {
- $this->processTwig();
- }
- } else {
- if ($this->content === false || $cache_enable === false) {
- $this->content = $this->raw_content;
- Grav::instance()->fireEvent('onPageContentRaw', new Event(['page' => $this]));
- if ($twig_first) {
- if ($process_twig) {
- $this->processTwig();
- }
- if ($process_markdown) {
- $this->processMarkdown();
- }
- // Content Processed but not cached yet
- Grav::instance()->fireEvent('onPageContentProcessed', new Event(['page' => $this]));
- } else {
- if ($process_markdown) {
- $this->processMarkdown();
- }
- // Content Processed but not cached yet
- Grav::instance()->fireEvent('onPageContentProcessed', new Event(['page' => $this]));
- if ($process_twig) {
- $this->processTwig();
- }
- }
- if ($cache_enable) {
- $this->cachePageContent();
- }
- }
- }
- // Handle summary divider
- $delimiter = $config->get('site.summary.delimiter', '===');
- $divider_pos = mb_strpos($this->content, "<p>{$delimiter}</p>");
- if ($divider_pos !== false) {
- $this->summary_size = $divider_pos;
- $this->content = str_replace("<p>{$delimiter}</p>", '', $this->content);
- }
- // Fire event when Page::content() is called
- Grav::instance()->fireEvent('onPageContent', new Event(['page' => $this]));
- }
- return $this->content;
- }
- /**
- * Get the contentMeta array and initialize content first if it's not already
- *
- * @return mixed
- */
- public function contentMeta()
- {
- if ($this->content === null) {
- $this->content();
- }
- return $this->getContentMeta();
- }
- /**
- * Add an entry to the page's contentMeta array
- *
- * @param string $name
- * @param string $value
- */
- public function addContentMeta($name, $value)
- {
- $this->content_meta[$name] = $value;
- }
- /**
- * Return the whole contentMeta array as it currently stands
- *
- * @param string|null $name
- *
- * @return string
- */
- public function getContentMeta($name = null)
- {
- if ($name) {
- if (isset($this->content_meta[$name])) {
- return $this->content_meta[$name];
- }
- return null;
- }
- return $this->content_meta;
- }
- /**
- * Sets the whole content meta array in one shot
- *
- * @param array $content_meta
- *
- * @return array
- */
- public function setContentMeta($content_meta)
- {
- return $this->content_meta = $content_meta;
- }
- /**
- * Process the Markdown content. Uses Parsedown or Parsedown Extra depending on configuration
- */
- protected function processMarkdown()
- {
- /** @var Config $config */
- $config = Grav::instance()['config'];
- $markdownDefaults = (array)$config->get('system.pages.markdown');
- if (isset($this->header()->markdown)) {
- $markdownDefaults = array_merge($markdownDefaults, $this->header()->markdown);
- }
- // pages.markdown_extra is deprecated, but still check it...
- if (!isset($markdownDefaults['extra']) && (isset($this->markdown_extra) || $config->get('system.pages.markdown_extra') !== null)) {
- user_error('Configuration option \'system.pages.markdown_extra\' is deprecated since Grav 1.5, use \'system.pages.markdown.extra\' instead', E_USER_DEPRECATED);
- $markdownDefaults['extra'] = $this->markdown_extra ?: $config->get('system.pages.markdown_extra');
- }
- $extra = $markdownDefaults['extra'] ?? false;
- $defaults = [
- 'markdown' => $markdownDefaults,
- 'images' => $config->get('system.images', [])
- ];
- $excerpts = new Excerpts($this, $defaults);
- // Initialize the preferred variant of Parsedown
- if ($extra) {
- $parsedown = new ParsedownExtra($excerpts);
- } else {
- $parsedown = new Parsedown($excerpts);
- }
- $this->content = $parsedown->text($this->content);
- }
- /**
- * Process the Twig page content.
- */
- private function processTwig()
- {
- $twig = Grav::instance()['twig'];
- $this->content = $twig->processPage($this, $this->content);
- }
- /**
- * Fires the onPageContentProcessed event, and caches the page content using a unique ID for the page
- */
- public function cachePageContent()
- {
- $cache = Grav::instance()['cache'];
- $cache_id = md5('page' . $this->getCacheKey());
- $cache->save($cache_id, ['content' => $this->content, 'content_meta' => $this->content_meta]);
- }
- /**
- * Needed by the onPageContentProcessed event to get the raw page content
- *
- * @return string the current page content
- */
- public function getRawContent()
- {
- return $this->content;
- }
- /**
- * Needed by the onPageContentProcessed event to set the raw page content
- *
- * @param string $content
- */
- public function setRawContent($content)
- {
- $this->content = $content ?? '';
- }
- /**
- * Get value from a page variable (used mostly for creating edit forms).
- *
- * @param string $name Variable name.
- * @param mixed $default
- *
- * @return mixed
- */
- public function value($name, $default = null)
- {
- if ($name === 'content') {
- return $this->raw_content;
- }
- if ($name === 'route') {
- $parent = $this->parent();
- return $parent ? $parent->rawRoute() : '';
- }
- if ($name === 'order') {
- $order = $this->order();
- return $order ? (int)$this->order() : '';
- }
- if ($name === 'ordering') {
- return (bool)$this->order();
- }
- if ($name === 'folder') {
- return preg_replace(PAGE_ORDER_PREFIX_REGEX, '', $this->folder);
- }
- if ($name === 'slug') {
- return $this->slug();
- }
- if ($name === 'name') {
- $language = $this->language() ? '.' . $this->language() : '';
- $name_val = str_replace($language . '.md', '', $this->name());
- if ($this->modular()) {
- return 'modular/' . $name_val;
- }
- return $name_val;
- }
- if ($name === 'media') {
- return $this->media()->all();
- }
- if ($name === 'media.file') {
- return $this->media()->files();
- }
- if ($name === 'media.video') {
- return $this->media()->videos();
- }
- if ($name === 'media.image') {
- return $this->media()->images();
- }
- if ($name === 'media.audio') {
- return $this->media()->audios();
- }
- $path = explode('.', $name);
- $scope = array_shift($path);
- if ($name === 'frontmatter') {
- return $this->frontmatter;
- }
- if ($scope === 'header') {
- $current = $this->header();
- foreach ($path as $field) {
- if (is_object($current) && isset($current->{$field})) {
- $current = $current->{$field};
- } elseif (is_array($current) && isset($current[$field])) {
- $current = $current[$field];
- } else {
- return $default;
- }
- }
- return $current;
- }
- return $default;
- }
- /**
- * Gets and Sets the Page raw content
- *
- * @param string|null $var
- *
- * @return string
- */
- public function rawMarkdown($var = null)
- {
- if ($var !== null) {
- $this->raw_content = $var;
- }
- return $this->raw_content;
- }
- /**
- * Get file object to the page.
- *
- * @return MarkdownFile|null
- */
- public function file()
- {
- if ($this->name) {
- return MarkdownFile::instance($this->filePath());
- }
- return null;
- }
- /**
- * Save page if there's a file assigned to it.
- *
- * @param bool|mixed $reorder Internal use.
- */
- public function save($reorder = true)
- {
- // Perform move, copy [or reordering] if needed.
- $this->doRelocation();
- $file = $this->file();
- if ($file) {
- $file->filename($this->filePath());
- $file->header((array)$this->header());
- $file->markdown($this->raw_content);
- $file->save();
- }
- // Perform reorder if required
- if ($reorder && is_array($reorder)) {
- $this->doReorder($reorder);
- }
- $this->_original = null;
- }
- /**
- * Prepare move page to new location. Moves also everything that's under the current page.
- *
- * You need to call $this->save() in order to perform the move.
- *
- * @param PageInterface $parent New parent page.
- *
- * @return $this
- */
- public function move(PageInterface $parent)
- {
- if (!$this->_original) {
- $clone = clone $this;
- $this->_original = $clone;
- }
- $this->_action = 'move';
- if ($this->route() === $parent->route()) {
- throw new \RuntimeException('Failed: Cannot set page parent to self');
- }
- if (Utils::startsWith($parent->rawRoute(), $this->rawRoute())) {
- throw new \RuntimeException('Failed: Cannot set page parent to a child of current page');
- }
- $this->parent($parent);
- $this->id(time() . md5($this->filePath()));
- if ($parent->path()) {
- $this->path($parent->path() . '/' . $this->folder());
- }
- if ($parent->route()) {
- $this->route($parent->route() . '/' . $this->slug());
- } else {
- $this->route(Grav::instance()['pages']->root()->route() . '/' . $this->slug());
- }
- $this->raw_route = null;
- return $this;
- }
- /**
- * Prepare a copy from the page. Copies also everything that's under the current page.
- *
- * Returns a new Page object for the copy.
- * You need to call $this->save() in order to perform the move.
- *
- * @param PageInterface $parent New parent page.
- *
- * @return $this
- */
- public function copy(PageInterface $parent)
- {
- $this->move($parent);
- $this->_action = 'copy';
- return $this;
- }
- /**
- * Get blueprints for the page.
- *
- * @return Blueprint
- */
- public function blueprints()
- {
- $grav = Grav::instance();
- /** @var Pages $pages */
- $pages = $grav['pages'];
- $blueprint = $pages->blueprints($this->blueprintName());
- $fields = $blueprint->fields();
- $edit_mode = isset($grav['admin']) ? $grav['config']->get('plugins.admin.edit_mode') : null;
- // override if you only want 'normal' mode
- if (empty($fields) && ($edit_mode === 'auto' || $edit_mode === 'normal')) {
- $blueprint = $pages->blueprints('default');
- }
- // override if you only want 'expert' mode
- if (!empty($fields) && $edit_mode === 'expert') {
- $blueprint = $pages->blueprints('');
- }
- return $blueprint;
- }
- /**
- * Get the blueprint name for this page. Use the blueprint form field if set
- *
- * @return string
- */
- public function blueprintName()
- {
- $blueprint_name = filter_input(INPUT_POST, 'blueprint', FILTER_SANITIZE_STRING) ?: $this->template();
- return $blueprint_name;
- }
- /**
- * Validate page header.
- *
- * @throws \Exception
- */
- public function validate()
- {
- $blueprints = $this->blueprints();
- $blueprints->validate($this->toArray());
- }
- /**
- * Filter page header from illegal contents.
- */
- public function filter()
- {
- $blueprints = $this->blueprints();
- $values = $blueprints->filter($this->toArray());
- if ($values && isset($values['header'])) {
- $this->header($values['header']);
- }
- }
- /**
- * Get unknown header variables.
- *
- * @return array
- */
- public function extra()
- {
- $blueprints = $this->blueprints();
- return $blueprints->extra($this->toArray()['header'], 'header.');
- }
- /**
- * Convert page to an array.
- *
- * @return array
- */
- public function toArray()
- {
- return [
- 'header' => (array)$this->header(),
- 'content' => (string)$this->value('content')
- ];
- }
- /**
- * Convert page to YAML encoded string.
- *
- * @return string
- */
- public function toYaml()
- {
- return Yaml::dump($this->toArray(), 20);
- }
- /**
- * Convert page to JSON encoded string.
- *
- * @return string
- */
- public function toJson()
- {
- return json_encode($this->toArray());
- }
- /**
- * @return string
- */
- public function getCacheKey(): string
- {
- return $this->id();
- }
- /**
- * Returns normalized list of name => form pairs.
- *
- * @return array
- */
- public function forms()
- {
- if (null === $this->forms) {
- $header = $this->header();
- // Call event to allow filling the page header form dynamically (e.g. use case: Comments plugin)
- $grav = Grav::instance();
- $grav->fireEvent('onFormPageHeaderProcessed', new Event(['page' => $this, 'header' => $header]));
- $rules = $header->rules ?? null;
- if (!\is_array($rules)) {
- $rules = [];
- }
- $forms = [];
- // First grab page.header.form
- $form = $this->normalizeForm($header->form ?? null, null, $rules);
- if ($form) {
- $forms[$form['name']] = $form;
- }
- // Append page.header.forms (override singular form if it clashes)
- $headerForms = $header->forms ?? null;
- if (\is_array($headerForms)) {
- foreach ($headerForms as $name => $form) {
- $form = $this->normalizeForm($form, $name, $rules);
- if ($form) {
- $forms[$form['name']] = $form;
- }
- }
- }
- $this->forms = $forms;
- }
- return $this->forms;
- }
- /**
- * @param array $new
- */
- public function addForms(array $new)
- {
- // Initialize forms.
- $this->forms();
- foreach ($new as $form) {
- $form = $this->normalizeForm($form);
- if ($form) {
- $this->forms[$form['name']] = $form;
- }
- }
- }
- protected function normalizeForm($form, $name = null, array $rules = [])
- {
- if (!\is_array($form)) {
- return null;
- }
- // Ignore numeric indexes on name.
- if (!$name || (string)(int)$name === (string)$name) {
- $name = null;
- }
- $name = $name ?? $form['name'] ?? $this->slug();
- $formRules = $form['rules'] ?? null;
- if (!\is_array($formRules)) {
- $formRules = [];
- }
- return ['name' => $name, 'rules' => $rules + $formRules] + $form;
- }
- /**
- * Gets and sets the associated media as found in the page folder.
- *
- * @param Media $var Representation of associated media.
- *
- * @return Media Representation of associated media.
- */
- public function media($var = null)
- {
- if ($var) {
- $this->setMedia($var);
- }
- return $this->getMedia();
- }
- /**
- * Get filesystem path to the associated media.
- *
- * @return string|null
- */
- public function getMediaFolder()
- {
- return $this->path();
- }
- /**
- * Get display order for the associated media.
- *
- * @return array Empty array means default ordering.
- */
- public function getMediaOrder()
- {
- $header = $this->header();
- return isset($header->media_order) ? array_map('trim', explode(',', (string)$header->media_order)) : [];
- }
- /**
- * Gets and sets the name field. If no name field is set, it will return 'default.md'.
- *
- * @param string $var The name of this page.
- *
- * @return string The name of this page.
- */
- public function name($var = null)
- {
- if ($var !== null) {
- $this->name = $var;
- }
- return $this->name ?: 'default.md';
- }
- /**
- * Returns child page type.
- *
- * @return string
- */
- public function childType()
- {
- return isset($this->header->child_type) ? (string)$this->header->child_type : '';
- }
- /**
- * Gets and sets the template field. This is used to find the correct Twig template file to render.
- * If no field is set, it will return the name without the .md extension
- *
- * @param string $var the template name
- *
- * @return string the template name
- */
- public function template($var = null)
- {
- if ($var !== null) {
- $this->template = $var;
- }
- if (empty($this->template)) {
- $this->template = ($this->modular() ? 'modular/' : '') . str_replace($this->extension(), '', $this->name());
- }
- return $this->template;
- }
- /**
- * Allows a page to override the output render format, usually the extension provided
- * in the URL. (e.g. `html`, `json`, `xml`, etc).
- *
- * @param null $var
- *
- * @return null
- */
- public function templateFormat($var = null)
- {
- if ($var !== null) {
- $this->template_format = $var;
- return $this->template_format;
- }
- if (isset($this->template_format)) {
- return $this->template_format;
- }
- // Set from URL extension set on page
- $page_extension = trim($this->header->append_url_extension ?? '' , '.');
- if (!empty($page_extension)) {
- $this->template_format = $page_extension;
- return $this->template_format;
- }
- // Set from uri extension
- $uri_extension = Grav::instance()['uri']->extension();
- if (is_string($uri_extension)) {
- $this->template_format = $uri_extension;
- return $this->template_format;
- }
- // Use content negotiation via the `accept:` header
- $http_accept = $_SERVER['HTTP_ACCEPT'] ?? null;
- if (is_string($http_accept)) {
- $negotiator = new Negotiator();
- $supported_types = Utils::getSupportPageTypes(['html', 'json']);
- $priorities = Utils::getMimeTypes($supported_types);
- $media_type = $negotiator->getBest($http_accept, $priorities);
- $mimetype = $media_type instanceof Accept ? $media_type->getValue() : '';
- $this->template_format = Utils::getExtensionByMime($mimetype);
- return $this->template_format;
- }
- // Last chance set a default type
- $this->template_format = 'html';
- return $this->template_format;
- }
- /**
- * Gets and sets the extension field.
- *
- * @param null $var
- *
- * @return null|string
- */
- public function extension($var = null)
- {
- if ($var !== null) {
- $this->extension = $var;
- }
- if (empty($this->extension)) {
- $this->extension = '.' . pathinfo($this->name(), PATHINFO_EXTENSION);
- }
- return $this->extension;
- }
- /**
- * Returns the page extension, got from the page `url_extension` config and falls back to the
- * system config `system.pages.append_url_extension`.
- *
- * @return string The extension of this page. For example `.html`
- */
- public function urlExtension()
- {
- if ($this->home()) {
- return '';
- }
- // if not set in the page get the value from system config
- if (null === $this->url_extension) {
- $this->url_extension = Grav::instance()['config']->get('system.pages.append_url_extension', '');
- }
- return $this->url_extension;
- }
- /**
- * Gets and sets the expires field. If not set will return the default
- *
- * @param int $var The new expires value.
- *
- * @return int The expires value
- */
- public function expires($var = null)
- {
- if ($var !== null) {
- $this->expires = $var;
- }
- return $this->expires ?? Grav::instance()['config']->get('system.pages.expires');
- }
- /**
- * Gets and sets the cache-control property. If not set it will return the default value (null)
- * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control for more details on valid options
- *
- * @param null $var
- * @return null
- */
- public function cacheControl($var = null)
- {
- if ($var !== null) {
- $this->cache_control = $var;
- }
- return $this->cache_control ?? Grav::instance()['config']->get('system.pages.cache_control');
- }
- /**
- * Gets and sets the title for this Page. If no title is set, it will use the slug() to get a name
- *
- * @param string $var the title of the Page
- *
- * @return string the title of the Page
- */
- public function title($var = null)
- {
- if ($var !== null) {
- $this->title = $var;
- }
- if (empty($this->title)) {
- $this->title = ucfirst($this->slug());
- }
- return $this->title;
- }
- /**
- * Gets and sets the menu name for this Page. This is the text that can be used specifically for navigation.
- * If no menu field is set, it will use the title()
- *
- * @param string $var the menu field for the page
- *
- * @return string the menu field for the page
- */
- public function menu($var = null)
- {
- if ($var !== null) {
- $this->menu = $var;
- }
- if (empty($this->menu)) {
- $this->menu = $this->title();
- }
- return $this->menu;
- }
- /**
- * Gets and Sets whether or not this Page is visible for navigation
- *
- * @param bool $var true if the page is visible
- *
- * @return bool true if the page is visible
- */
- public function visible($var = null)
- {
- if ($var !== null) {
- $this->visible = (bool)$var;
- }
- if ($this->visible === null) {
- // Set item visibility in menu if folder is different from slug
- // eg folder = 01.Home and slug = Home
- if (preg_match(PAGE_ORDER_PREFIX_REGEX, $this->folder)) {
- $this->visible = true;
- } else {
- $this->visible = false;
- }
- }
- return $this->visible;
- }
- /**
- * Gets and Sets whether or not this Page is considered published
- *
- * @param bool $var true if the page is published
- *
- * @return bool true if the page is published
- */
- public function published($var = null)
- {
- if ($var !== null) {
- $this->published = (bool)$var;
- }
- // If not published, should not be visible in menus either
- if ($this->published === false) {
- $this->visible = false;
- }
- return $this->published;
- }
- /**
- * Gets and Sets the Page publish date
- *
- * @param string $var string representation of a date
- *
- * @return int unix timestamp representation of the date
- */
- public function publishDate($var = null)
- {
- if ($var !== null) {
- $this->publish_date = Utils::date2timestamp($var, $this->dateformat);
- }
- return $this->publish_date;
- }
- /**
- * Gets and Sets the Page unpublish date
- *
- * @param string $var string representation of a date
- *
- * @return int|null unix timestamp representation of the date
- */
- public function unpublishDate($var = null)
- {
- if ($var !== null) {
- $this->unpublish_date = Utils::date2timestamp($var, $this->dateformat);
- }
- return $this->unpublish_date;
- }
- /**
- * Gets and Sets whether or not this Page is routable, ie you can reach it
- * via a URL.
- * The page must be *routable* and *published*
- *
- * @param bool $var true if the page is routable
- *
- * @return bool true if the page is routable
- */
- public function routable($var = null)
- {
- if ($var !== null) {
- $this->routable = (bool)$var;
- }
- return $this->routable && $this->published();
- }
- public function ssl($var = null)
- {
- if ($var !== null) {
- $this->ssl = (bool)$var;
- }
- return $this->ssl;
- }
- /**
- * Gets and Sets the process setup for this Page. This is multi-dimensional array that consists of
- * a simple array of arrays with the form array("markdown"=>true) for example
- *
- * @param array $var an Array of name value pairs where the name is the process and value is true or false
- *
- * @return array an Array of name value pairs where the name is the process and value is true or false
- */
- public function process($var = null)
- {
- if ($var !== null) {
- $this->process = (array)$var;
- }
- return $this->process;
- }
- /**
- * Returns the state of the debugger override etting for this page
- *
- * @return mixed
- */
- public function debugger()
- {
- return !(isset($this->debugger) && $this->debugger === false);
- }
- /**
- * Function to merge page metadata tags and build an array of Metadata objects
- * that can then be rendered in the page.
- *
- * @param array $var an Array of metadata values to set
- *
- * @return array an Array of metadata values for the page
- */
- public function metadata($var = null)
- {
- if ($var !== null) {
- $this->metadata = (array)$var;
- }
- // if not metadata yet, process it.
- if (null === $this->metadata) {
- $header_tag_http_equivs = ['content-type', 'default-style', 'refresh', 'x-ua-compatible'];
- $this->metadata = [];
- $metadata = [];
- // Set the Generator tag
- $metadata['generator'] = 'GravCMS';
- // Get initial metadata for the page
- $metadata = array_merge($metadata, Grav::instance()['config']->get('site.metadata', []));
- if (isset($this->header->metadata) && is_array($this->header->metadata)) {
- // Merge any site.metadata settings in with page metadata
- $metadata = array_merge($metadata, $this->header->metadata);
- }
- // Build an array of meta objects..
- foreach ((array)$metadata as $key => $value) {
- // Lowercase the key
- $key = strtolower($key);
- // If this is a property type metadata: "og", "twitter", "facebook" etc
- // Backward compatibility for nested arrays in metas
- if (is_array($value)) {
- foreach ($value as $property => $prop_value) {
- $prop_key = $key . ':' . $property;
- $this->metadata[$prop_key] = [
- 'name' => $prop_key,
- 'property' => $prop_key,
- 'content' => htmlspecialchars($prop_value, ENT_QUOTES, 'UTF-8')
- ];
- }
- } else {
- // If it this is a standard meta data type
- if ($value) {
- if (\in_array($key, $header_tag_http_equivs, true)) {
- $this->metadata[$key] = [
- 'http_equiv' => $key,
- 'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')
- ];
- } elseif ($key === 'charset') {
- $this->metadata[$key] = ['charset' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')];
- } else {
- // if it's a social metadata with separator, render as property
- $separator = strpos($key, ':');
- $hasSeparator = $separator && $separator < strlen($key) - 1;
- $entry = [
- 'content' => htmlspecialchars($value, ENT_QUOTES, 'UTF-8')
- ];
- if ($hasSeparator && !Utils::startsWith($key, 'twitter')) {
- $entry['property'] = $key;
- } else {
- $entry['name'] = $key;
- }
- $this->metadata[$key] = $entry;
- }
- }
- }
- }
- }
- return $this->metadata;
- }
- /**
- * Reset the metadata and pull from header again
- */
- public function resetMetadata()
- {
- $this->metadata = null;
- }
- /**
- * Gets and Sets the slug for the Page. The slug is used in the URL routing. If not set it uses
- * the parent folder from the path
- *
- * @param string $var the slug, e.g. 'my-blog'
- *
- * @return string the slug
- */
- public function slug($var = null)
- {
- if ($var !== null && $var !== '') {
- $this->slug = $var;
- }
- if (empty($this->slug)) {
- $this->slug = $this->adjustRouteCase(preg_replace(PAGE_ORDER_PREFIX_REGEX, '', $this->folder)) ?: null;
- }
- return $this->slug;
- }
- /**
- * Get/set order number of this page.
- *
- * @param int $var
- *
- * @return int|bool
- */
- public function order($var = null)
- {
- if ($var !== null) {
- $order = $var ? sprintf('%02d.', (int)$var) : '';
- $this->folder($order . preg_replace(PAGE_ORDER_PREFIX_REGEX, '', $this->folder));
- return $order;
- }
- preg_match(PAGE_ORDER_PREFIX_REGEX, $this->folder, $order);
- return $order[0] ?? false;
- }
- /**
- * Gets the URL for a page - alias of url().
- *
- * @param bool $include_host
- *
- * @return string the permalink
- */
- public function link($include_host = false)
- {
- return $this->url($include_host);
- }
- /**
- * Gets the URL with host information, aka Permalink.
- * @return string The permalink.
- */
- public function permalink()
- {
- return $this->url(true, false, true, true);
- }
- /**
- * Returns the canonical URL for a page
- *
- * @param bool $include_lang
- *
- * @return string
- */
- public function canonical($include_lang = true)
- {
- return $this->url(true, true, $include_lang);
- }
- /**
- * Gets the url for the Page.
- *
- * @param bool $include_host Defaults false, but true would include http://yourhost.com
- * @param bool $canonical True to return the canonical URL
- * @param bool $include_base Include base url on multisite as well as language code
- * @param bool $raw_route
- *
- * @return string The url.
- */
- public function url($include_host = false, $canonical = false, $include_base = true, $raw_route = false)
- {
- // Override any URL when external_url is set
- if (isset($this->external_url)) {
- return $this->external_url;
- }
- $grav = Grav::instance();
- /** @var Pages $pages */
- $pages = $grav['pages'];
- /** @var Config $config */
- $config = $grav['config'];
- // get base route (multi-site base and language)
- $route = $include_base ? $pages->baseRoute() : '';
- // add full route if configured to do so
- if (!$include_host && $config->get('system.absolute_urls', false)) {
- $include_host = true;
- }
- if ($canonical) {
- $route .= $this->routeCanonical();
- } elseif ($raw_route) {
- $route .= $this->rawRoute();
- } else {
- $route .= $this->route();
- }
- /** @var Uri $uri */
- $uri = $grav['uri'];
- $url = $uri->rootUrl($include_host) . '/' . trim($route, '/') . $this->urlExtension();
- // trim trailing / if not root
- if ($url !== '/') {
- $url = rtrim($url, '/');
- }
- return Uri::filterPath($url);
- }
- /**
- * Gets the route for the page based on the route headers if available, else from
- * the parents route and the current Page's slug.
- *
- * @param string $var Set new default route.
- *
- * @return string The route for the Page.
- */
- public function route($var = null)
- {
- if ($var !== null) {
- $this->route = $var;
- }
- if (empty($this->route)) {
- $baseRoute = null;
- // calculate route based on parent slugs
- $parent = $this->parent();
- if (isset($parent)) {
- if ($this->hide_home_route && $parent->route() === $this->home_route) {
- $baseRoute = '';
- } else {
- $baseRoute = (string)$parent->route();
- }
- }
- $this->route = isset($baseRoute) ? $baseRoute . '/' . $this->slug() : null;
- if (!empty($this->routes) && isset($this->routes['default'])) {
- $this->routes['aliases'][] = $this->route;
- $this->route = $this->routes['default'];
- return $this->route;
- }
- }
- return $this->route;
- }
- /**
- * Helper method to clear the route out so it regenerates next time you use it
- */
- public function unsetRouteSlug()
- {
- unset($this->route, $this->slug);
- }
- /**
- * Gets and Sets the page raw route
- *
- * @param null $var
- *
- * @return null|string
- */
- public function rawRoute($var = null)
- {
- if ($var !== null) {
- $this->raw_route = $var;
- }
- if (empty($this->raw_route)) {
- $parent = $this->parent();
- $baseRoute = $parent ? (string)$parent->rawRoute() : null;
- $slug = $this->adjustRouteCase(preg_replace(PAGE_ORDER_PREFIX_REGEX, '', $this->folder));
- $this->raw_route = isset($baseRoute) ? $baseRoute . '/' . $slug : null;
- }
- return $this->raw_route;
- }
- /**
- * Gets the route aliases for the page based on page headers.
- *
- * @param array $var list of route aliases
- *
- * @return array The route aliases for the Page.
- */
- public function routeAliases($var = null)
- {
- if ($var !== null) {
- $this->routes['aliases'] = (array)$var;
- }
- if (!empty($this->routes) && isset($this->routes['aliases'])) {
- return $this->routes['aliases'];
- }
- return [];
- }
- /**
- * Gets the canonical route for this page if its set. If provided it will use
- * that value, else if it's `true` it will use the default route.
- *
- * @param null $var
- *
- * @return bool|string
- */
- public function routeCanonical($var = null)
- {
- if ($var !== null) {
- $this->routes['canonical'] = $var;
- }
- if (!empty($this->routes) && isset($this->routes['canonical'])) {
- return $this->routes['canonical'];
- }
- return $this->route();
- }
- /**
- * Gets and sets the identifier for this Page object.
- *
- * @param string $var the identifier
- *
- * @return string the identifier
- */
- public function id($var = null)
- {
- if (null === $this->id) {
- // We need to set unique id to avoid potential cache conflicts between pages.
- $var = time() . md5($this->filePath());
- }
- if ($var !== null) {
- // store unique per language
- $active_lang = Grav::instance()['language']->getLanguage() ?: '';
- $id = $active_lang . $var;
- $this->id = $id;
- }
- return $this->id;
- }
- /**
- * Gets and sets the modified timestamp.
- *
- * @param int $var modified unix timestamp
- *
- * @return int modified unix timestamp
- */
- public function modified($var = null)
- {
- if ($var !== null) {
- $this->modified = $var;
- }
- return $this->modified;
- }
- /**
- * Gets the redirect set in the header.
- *
- * @param string $var redirect url
- *
- * @return string
- */
- public function redirect($var = null)
- {
- if ($var !== null) {
- $this->redirect = $var;
- }
- return $this->redirect;
- }
- /**
- * Gets and sets the option to show the etag header for the page.
- *
- * @param bool $var show etag header
- *
- * @return bool show etag header
- */
- public function eTag($var = null)
- {
- if ($var !== null) {
- $this->etag = $var;
- }
- if (!isset($this->etag)) {
- $this->etag = (bool)Grav::instance()['config']->get('system.pages.etag');
- }
- return $this->etag;
- }
- /**
- * Gets and sets the option to show the last_modified header for the page.
- *
- * @param bool $var show last_modified header
- *
- * @return bool show last_modified header
- */
- public function lastModified($var = null)
- {
- if ($var !== null) {
- $this->last_modified = $var;
- }
- if (!isset($this->last_modified)) {
- $this->last_modified = (bool)Grav::instance()['config']->get('system.pages.last_modified');
- }
- return $this->last_modified;
- }
- /**
- * Gets and sets the path to the .md file for this Page object.
- *
- * @param string $var the file path
- *
- * @return string|null the file path
- */
- public function filePath($var = null)
- {
- if ($var !== null) {
- // Filename of the page.
- $this->name = basename($var);
- // Folder of the page.
- $this->folder = basename(dirname($var));
- // Path to the page.
- $this->path = dirname($var, 2);
- }
- return $this->path . '/' . $this->folder . '/' . ($this->name ?: '');
- }
- /**
- * Gets the relative path to the .md file
- *
- * @return string The relative file path
- */
- public function filePathClean()
- {
- return str_replace(ROOT_DIR, '', $this->filePath());
- }
- /**
- * Returns the clean path to the page file
- */
- public function relativePagePath()
- {
- return str_replace('/' . $this->name(), '', $this->filePathClean());
- }
- /**
- * Gets and sets the path to the folder where the .md for this Page object resides.
- * This is equivalent to the filePath but without the filename.
- *
- * @param string $var the path
- *
- * @return string|null the path
- */
- public function path($var = null)
- {
- if ($var !== null) {
- // Folder of the page.
- $this->folder = basename($var);
- // Path to the page.
- $this->path = dirname($var);
- }
- return $this->path ? $this->path . '/' . $this->folder : null;
- }
- /**
- * Get/set the folder.
- *
- * @param string $var Optional path
- *
- * @return string|null
- */
- public function folder($var = null)
- {
- if ($var !== null) {
- $this->folder = $var;
- }
- return $this->folder;
- }
- /**
- * Gets and sets the date for this Page object. This is typically passed in via the page headers
- *
- * @param string $var string representation of a date
- *
- * @return int unix timestamp representation of the date
- */
- public function date($var = null)
- {
- if ($var !== null) {
- $this->date = Utils::date2timestamp($var, $this->dateformat);
- }
- if (!$this->date) {
- $this->date = $this->modified;
- }
- return $this->date;
- }
- /**
- * Gets and sets the date format for this Page object. This is typically passed in via the page headers
- * using typical PHP date string structure - http://php.net/manual/en/function.date.php
- *
- * @param string $var string representation of a date format
- *
- * @return string string representation of a date format
- */
- public function dateformat($var = null)
- {
- if ($var !== null) {
- $this->dateformat = $var;
- }
- return $this->dateformat;
- }
- /**
- * Gets and sets the order by which any sub-pages should be sorted.
- *
- * @param string $var the order, either "asc" or "desc"
- *
- * @return string the order, either "asc" or "desc"
- * @deprecated 1.6
- */
- public function orderDir($var = null)
- {
- //user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6', E_USER_DEPRECATED);
- if ($var !== null) {
- $this->order_dir = $var;
- }
- if (empty($this->order_dir)) {
- $this->order_dir = 'asc';
- }
- return $this->order_dir;
- }
- /**
- * Gets and sets the order by which the sub-pages should be sorted.
- *
- * default - is the order based on the file system, ie 01.Home before 02.Advark
- * title - is the order based on the title set in the pages
- * date - is the order based on the date set in the pages
- * folder - is the order based on the name of the folder with any numerics omitted
- *
- * @param string $var supported options include "default", "title", "date", and "folder"
- *
- * @return string supported options include "default", "title", "date", and "folder"
- * @deprecated 1.6
- */
- public function orderBy($var = null)
- {
- //user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6', E_USER_DEPRECATED);
- if ($var !== null) {
- $this->order_by = $var;
- }
- return $this->order_by;
- }
- /**
- * Gets the manual order set in the header.
- *
- * @param string $var supported options include "default", "title", "date", and "folder"
- *
- * @return array
- * @deprecated 1.6
- */
- public function orderManual($var = null)
- {
- //user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6', E_USER_DEPRECATED);
- if ($var !== null) {
- $this->order_manual = $var;
- }
- return (array)$this->order_manual;
- }
- /**
- * Gets and sets the maxCount field which describes how many sub-pages should be displayed if the
- * sub_pages header property is set for this page object.
- *
- * @param int $var the maximum number of sub-pages
- *
- * @return int the maximum number of sub-pages
- * @deprecated 1.6
- */
- public function maxCount($var = null)
- {
- //user_error(__CLASS__ . '::' . __FUNCTION__ . '() is deprecated since Grav 1.6', E_USER_DEPRECATED);
- if ($var !== null) {
- $this->max_count = (int)$var;
- }
- if (empty($this->max_count)) {
- /** @var Config $config */
- $config = Grav::instance()['config'];
- $this->max_count = (int)$config->get('system.pages.list.count');
- }
- return $this->max_count;
- }
- /**
- * Gets and sets the taxonomy array which defines which taxonomies this page identifies itself with.
- *
- * @param array $var an array of taxonomies
- *
- * @return array an array of taxonomies
- */
- public function taxonomy($var = null)
- {
- if ($var !== null) {
- // make sure first level are arrays
- array_walk($var, function(&$value) {
- $value = (array) $value;
- });
- // make sure all values are strings
- array_walk_recursive($var, function(&$value) {
- $value = (string) $value;
- });
- $this->taxonomy = $var;
- }
- return $this->taxonomy;
- }
- /**
- * Gets and sets the modular var that helps identify this page is a modular child
- *
- * @param bool $var true if modular_twig
- *
- * @return bool true if modular_twig
- */
- public function modular($var = null)
- {
- return $this->modularTwig($var);
- }
- /**
- * Gets and sets the modular_twig var that helps identify this page as a modular child page that will need
- * twig processing handled differently from a regular page.
- *
- * @param bool $var true if modular_twig
- *
- * @return bool true if modular_twig
- */
- public function modularTwig($var = null)
- {
- if ($var !== null) {
- $this->modular_twig = (bool)$var;
- if ($var) {
- $this->visible(false);
- // some routable logic
- if (empty($this->header->routable)) {
- $this->routable = false;
- }
- }
- }
- return $this->modular_twig;
- }
- /**
- * Gets the configured state of the processing method.
- *
- * @param string $process the process, eg "twig" or "markdown"
- *
- * @return bool whether or not the processing method is enabled for this Page
- */
- public function shouldProcess($process)
- {
- return (bool)($this->process[$process] ?? false);
- }
- /**
- * Gets and Sets the parent object for this page
- *
- * @param PageInterface $var the parent page object
- *
- * @return PageInterface|null the parent page object if it exists.
- */
- public function parent(PageInterface $var = null)
- {
- if ($var) {
- $this->parent = $var->path();
- return $var;
- }
- /** @var Pages $pages */
- $pages = Grav::instance()['pages'];
- return $pages->get($this->parent);
- }
- /**
- * Gets the top parent object for this page
- *
- * @return PageInterface|null the top parent page object if it exists.
- */
- public function topParent()
- {
- $topParent = $this->parent();
- if (!$topParent) {
- return null;
- }
- while (true) {
- $theParent = $topParent->parent();
- if ($theParent !== null && $theParent->parent() !== null) {
- $topParent = $theParent;
- } else {
- break;
- }
- }
- return $topParent;
- }
- /**
- * Returns children of this page.
- *
- * @return Collection
- */
- public function children()
- {
- /** @var Pages $pages */
- $pages = Grav::instance()['pages'];
- return $pages->children($this->path());
- }
- /**
- * Check to see if this item is the first in an array of sub-pages.
- *
- * @return bool True if item is first.
- */
- public function isFirst()
- {
- $parent = $this->parent();
- $collection = $parent ? $parent->collection('content', false) : null;
- if ($collection instanceof Collection) {
- return $collection->isFirst($this->path());
- }
- return true;
- }
- /**
- * Check to see if this item is the last in an array of sub-pages.
- *
- * @return bool True if item is last
- */
- public function isLast()
- {
- $parent = $this->parent();
- $collection = $parent ? $parent->collection('content', false) : null;
- if ($collection instanceof Collection) {
- return $collection->isLast($this->path());
- }
- return true;
- }
- /**
- * Gets the previous sibling based on current position.
- *
- * @return PageInterface the previous Page item
- */
- public function prevSibling()
- {
- return $this->adjacentSibling(-1);
- }
- /**
- * Gets the next sibling based on current position.
- *
- * @return PageInterface the next Page item
- */
- public function nextSibling()
- {
- return $this->adjacentSibling(1);
- }
- /**
- * Returns the adjacent sibling based on a direction.
- *
- * @param int $direction either -1 or +1
- *
- * @return PageInterface|bool the sibling page
- */
- public function adjacentSibling($direction = 1)
- {
- $parent = $this->parent();
- $collection = $parent ? $parent->collection('content', false) : null;
- if ($collection instanceof Collection) {
- return $collection->adjacentSibling($this->path(), $direction);
- }
- return false;
- }
- /**
- * Returns the item in the current position.
- *
- * @return int the index of the current page.
- */
- public function currentPosition()
- {
- $parent = $this->parent();
- $collection = $parent ? $parent->collection('content', false) : null;
- if ($collection instanceof Collection) {
- return $collection->currentPosition($this->path());
- }
- return 1;
- }
- /**
- * Returns whether or not this page is the currently active page requested via the URL.
- *
- * @return bool True if it is active
- */
- public function active()
- {
- $uri_path = rtrim(urldecode(Grav::instance()['uri']->path()), '/') ?: '/';
- $routes = Grav::instance()['pages']->routes();
- return isset($routes[$uri_path]) && $routes[$uri_path] === $this->path();
- }
- /**
- * Returns whether or not this URI's URL contains the URL of the active page.
- * Or in other words, is this page's URL in the current URL
- *
- * @return bool True if active child exists
- */
- public function activeChild()
- {
- $uri = Grav::instance()['uri'];
- $pages = Grav::instance()['pages'];
- $uri_path = rtrim(urldecode($uri->path()), '/');
- $routes = Grav::instance()['pages']->routes();
- if (isset($routes[$uri_path])) {
- /** @var PageInterface $child_page */
- $child_page = $pages->dispatch($uri->route())->parent();
- if ($child_page) {
- while (!$child_page->root()) {
- if ($this->path() === $child_page->path()) {
- return true;
- }
- $child_page = $child_page->parent();
- }
- }
- }
- return false;
- }
- /**
- * Returns whether or not this page is the currently configured home page.
- *
- * @return bool True if it is the homepage
- */
- public function home()
- {
- $home = Grav::instance()['config']->get('system.home.alias');
- return $this->route() === $home || $this->rawRoute() === $home;
- }
- /**
- * Returns whether or not this page is the root node of the pages tree.
- *
- * @return bool True if it is the root
- */
- public function root()
- {
- return !$this->parent && !$this->name && !$this->visible;
- }
- /**
- * Helper method to return an ancestor page.
- *
- * @param bool $lookup Name of the parent folder
- *
- * @return PageInterface page you were looking for if it exists
- */
- public function ancestor($lookup = null)
- {
- /** @var Pages $pages */
- $pages = Grav::instance()['pages'];
- return $pages->ancestor($this->route, $lookup);
- }
- /**
- * Helper method to return an ancestor page to inherit from. The current
- * page object is returned.
- *
- * @param string $field Name of the parent folder
- *
- * @return PageInterface
- */
- public function inherited($field)
- {
- list($inherited, $currentParams) = $this->getInheritedParams($field);
- $this->modifyHeader($field, $currentParams);
- return $inherited;
- }
- /**
- * Helper method to return an ancestor field only to inherit from. The
- * first occurrence of an ancestor field will be returned if at all.
- *
- * @param string $field Name of the parent folder
- *
- * @return array
- */
- public function inheritedField($field)
- {
- list($inherited, $currentParams) = $this->getInheritedParams($field);
- return $currentParams;
- }
- /**
- * Method that contains shared logic for inherited() and inheritedField()
- *
- * @param string $field Name of the parent folder
- *
- * @return array
- */
- protected function getInheritedParams($field)
- {
- $pages = Grav::instance()['pages'];
- /** @var Pages $pages */
- $inherited = $pages->inherited($this->route, $field);
- $inheritedParams = $inherited ? (array)$inherited->value('header.' . $field) : [];
- $currentParams = (array)$this->value('header.' . $field);
- if ($inheritedParams && is_array($inheritedParams)) {
- $currentParams = array_replace_recursive($inheritedParams, $currentParams);
- }
- return [$inherited, $currentParams];
- }
- /**
- * Helper method to return a page.
- *
- * @param string $url the url of the page
- * @param bool $all
- *
- * @return PageInterface page you were looking for if it exists
- */
- public function find($url, $all = false)
- {
- /** @var Pages $pages */
- $pages = Grav::instance()['pages'];
- return $pages->find($url, $all);
- }
- /**
- * Get a collection of pages in the current context.
- *
- * @param string|array $params
- * @param bool $pagination
- *
- * @return Collection
- * @throws \InvalidArgumentException
- */
- public function collection($params = 'content', $pagination = true)
- {
- if (is_string($params)) {
- $params = (array)$this->value('header.' . $params);
- } elseif (!is_array($params)) {
- throw new \InvalidArgumentException('Argument should be either header variable name or array of parameters');
- }
- if (!isset($params['items'])) {
- return new Collection();
- }
- // See if require published filter is set and use that, if assume published=true
- $only_published = true;
- if (isset($params['filter']['published']) && $params['filter']['published']) {
- $only_published = false;
- } elseif (isset($params['filter']['non-published']) && $params['filter']['non-published']) {
- $only_published = false;
- }
- $collection = $this->evaluate($params['items'], $only_published);
- if (!$collection instanceof Collection) {
- $collection = new Collection();
- }
- $collection->setParams($params);
- /** @var Uri $uri */
- $uri = Grav::instance()['uri'];
- /** @var Config $config */
- $config = Grav::instance()['config'];
- $process_taxonomy = $params['url_taxonomy_filters'] ?? $config->get('system.pages.url_taxonomy_filters');
- if ($process_taxonomy) {
- foreach ((array)$config->get('site.taxonomies') as $taxonomy) {
- if ($uri->param(rawurlencode($taxonomy))) {
- $items = explode(',', $uri->param($taxonomy));
- $collection->setParams(['taxonomies' => [$taxonomy => $items]]);
- foreach ($collection as $page) {
- // Don't filter modular pages
- if ($page->modular()) {
- continue;
- }
- foreach ($items as $item) {
- $item = rawurldecode($item);
- if (empty($page->taxonomy[$taxonomy]) || !\in_array(htmlspecialchars_decode($item, ENT_QUOTES), $page->taxonomy[$taxonomy], true)
- ) {
- $collection->remove($page->path());
- }
- }
- }
- }
- }
- }
- // If a filter or filters are set, filter the collection...
- if (isset($params['filter'])) {
- // remove any inclusive sets from filer:
- $sets = ['published', 'visible', 'modular', 'routable'];
- foreach ($sets as $type) {
- $var = "non-{$type}";
- if (isset($params['filter'][$type], $params['filter'][$var]) && $params['filter'][$type] && $params['filter'][$var]) {
- unset ($params['filter'][$type], $params['filter'][$var]);
- }
- }
- foreach ((array)$params['filter'] as $type => $filter) {
- switch ($type) {
- case 'published':
- if ((bool) $filter) {
- $collection->published();
- }
- break;
- case 'non-published':
- if ((bool) $filter) {
- $collection->nonPublished();
- }
- break;
- case 'visible':
- if ((bool) $filter) {
- $collection->visible();
- }
- break;
- case 'non-visible':
- if ((bool) $filter) {
- $collection->nonVisible();
- }
- break;
- case 'modular':
- if ((bool) $filter) {
- $collection->modular();
- }
- break;
- case 'non-modular':
- if ((bool) $filter) {
- $collection->nonModular();
- }
- break;
- case 'routable':
- if ((bool) $filter) {
- $collection->routable();
- }
- break;
- case 'non-routable':
- if ((bool) $filter) {
- $collection->nonRoutable();
- }
- break;
- case 'type':
- $collection->ofType($filter);
- break;
- case 'types':
- $collection->ofOneOfTheseTypes($filter);
- break;
- case 'access':
- $collection->ofOneOfTheseAccessLevels($filter);
- break;
- }
- }
- }
- if (isset($params['dateRange'])) {
- $start = $params['dateRange']['start'] ?? 0;
- $end = $params['dateRange']['end'] ?? false;
- $field = $params['dateRange']['field'] ?? false;
- $collection->dateRange($start, $end, $field);
- }
- if (isset($params['order'])) {
- $by = $params['order']['by'] ?? 'default';
- $dir = $params['order']['dir'] ?? 'asc';
- $custom = $params['order']['custom'] ?? null;
- $sort_flags = $params['order']['sort_flags'] ?? null;
- if (is_array($sort_flags)) {
- $sort_flags = array_map('constant', $sort_flags); //transform strings to constant value
- $sort_flags = array_reduce($sort_flags, function ($a, $b) {
- return $a | $b;
- }, 0); //merge constant values using bit or
- }
- $collection->order($by, $dir, $custom, $sort_flags);
- }
- /** @var Grav $grav */
- $grav = Grav::instance();
- // New Custom event to handle things like pagination.
- $grav->fireEvent('onCollectionProcessed', new Event(['collection' => $collection]));
- // Slice and dice the collection if pagination is required
- if ($pagination) {
- $params = $collection->params();
- $limit = (int)($params['limit'] ?? 0);
- $start = !empty($params['pagination']) ? ($uri->currentPage() - 1) * $limit : 0;
- if ($limit && $collection->count() > $limit) {
- $collection->slice($start, $limit);
- }
- }
- return $collection;
- }
- /**
- * @param string|array $value
- * @param bool $only_published
- * @return mixed
- */
- public function evaluate($value, $only_published = true)
- {
- // Parse command.
- if (is_string($value)) {
- // Format: @command.param
- $cmd = $value;
- $params = [];
- } elseif (is_array($value) && count($value) == 1 && !is_int(key($value))) {
- // Format: @command.param: { attr1: value1, attr2: value2 }
- $cmd = (string)key($value);
- $params = (array)current($value);
- } else {
- $result = [];
- foreach ((array)$value as $key => $val) {
- if (is_int($key)) {
- $result = $result + $this->evaluate($val, $only_published)->toArray();
- } else {
- $result = $result + $this->evaluate([$key => $val], $only_published)->toArray();
- }
- }
- return new Collection($result);
- }
- /** @var Pages $pages */
- $pages = Grav::instance()['pages'];
- $parts = explode('.', $cmd);
- $current = array_shift($parts);
- /** @var Collection $results */
- $results = new Collection();
- switch ($current) {
- case 'self@':
- case '@self':
- if (!empty($parts)) {
- switch ($parts[0]) {
- case 'modular':
- // @self.modular: false (alternative to @self.children)
- if (!empty($params) && $params[0] === false) {
- $results = $this->children()->nonModular();
- break;
- }
- $results = $this->children()->modular();
- break;
- case 'children':
- $results = $this->children()->nonModular();
- break;
- case 'all':
- $results = $this->children();
- break;
- case 'parent':
- $collection = new Collection();
- $results = $collection->addPage($this->parent());
- break;
- case 'siblings':
- if (!$this->parent()) {
- return new Collection();
- }
- $results = $this->parent()->children()->remove($this->path());
- break;
- case 'descendants':
- $results = $pages->all($this)->remove($this->path())->nonModular();
- break;
- }
- }
- break;
- case 'page@':
- case '@page':
- $page = null;
- if (!empty($params)) {
- $page = $this->find($params[0]);
- }
- // safety check in case page is not found
- if (!isset($page)) {
- return $results;
- }
- // Handle a @page.descendants
- if (!empty($parts)) {
- switch ($parts[0]) {
- case 'modular':
- $results = new Collection();
- foreach ($page->children() as $child) {
- $results = $results->addPage($child);
- }
- $results->modular();
- break;
- case 'page':
- case 'self':
- $results = new Collection();
- $results = $results->addPage($page);
- break;
- case 'descendants':
- $results = $pages->all($page)->remove($page->path())->nonModular();
- break;
- case 'children':
- $results = $page->children()->nonModular();
- break;
- }
- } else {
- $results = $page->children()->nonModular();
- }
- break;
- case 'root@':
- case '@root':
- if (!empty($parts) && $parts[0] === 'descendants') {
- $results = $pages->all($pages->root())->nonModular();
- } else {
- $results = $pages->root()->children()->nonModular();
- }
- break;
- case 'taxonomy@':
- case '@taxonomy':
- // Gets a collection of pages by using one of the following formats:
- // @taxonomy.category: blog
- // @taxonomy.category: [ blog, featured ]
- // @taxonomy: { category: [ blog, featured ], level: 1 }
- /** @var Taxonomy $taxonomy_map */
- $taxonomy_map = Grav::instance()['taxonomy'];
- if (!empty($parts)) {
- $params = [implode('.', $parts) => $params];
- }
- $results = $taxonomy_map->findTaxonomy($params);
- break;
- }
- if ($only_published) {
- $results = $results->published();
- }
- return $results;
- }
- /**
- * Returns whether or not this Page object has a .md file associated with it or if its just a directory.
- *
- * @return bool True if its a page with a .md file associated
- */
- public function isPage()
- {
- if ($this->name) {
- return true;
- }
- return false;
- }
- /**
- * Returns whether or not this Page object is a directory or a page.
- *
- * @return bool True if its a directory
- */
- public function isDir()
- {
- return !$this->isPage();
- }
- /**
- * Returns whether the page exists in the filesystem.
- *
- * @return bool
- */
- public function exists()
- {
- $file = $this->file();
- return $file && $file->exists();
- }
- /**
- * Returns whether or not the current folder exists
- *
- * @return bool
- */
- public function folderExists()
- {
- return file_exists($this->path());
- }
- /**
- * Cleans the path.
- *
- * @param string $path the path
- *
- * @return string the path
- */
- protected function cleanPath($path)
- {
- $lastchunk = strrchr($path, DS);
- if (strpos($lastchunk, ':') !== false) {
- $path = str_replace($lastchunk, '', $path);
- }
- return $path;
- }
- /**
- * Reorders all siblings according to a defined order
- *
- * @param array|null $new_order
- */
- protected function doReorder($new_order)
- {
- if (!$this->_original) {
- return;
- }
- $pages = Grav::instance()['pages'];
- $pages->init();
- $this->_original->path($this->path());
- $parent = $this->parent();
- $siblings = $parent ? $parent->children() : null;
- if ($siblings) {
- $siblings->order('slug', 'asc', $new_order);
- $counter = 0;
- // Reorder all moved pages.
- foreach ($siblings as $slug => $page) {
- $order = (int)trim($page->order(), '.');
- $counter++;
- if ($order) {
- if ($page->path() === $this->path() && $this->folderExists()) {
- // Handle current page; we do want to change ordering number, but nothing else.
- $this->order($counter);
- $this->save(false);
- } else {
- // Handle all the other pages.
- $page = $pages->get($page->path());
- if ($page && $page->folderExists() && !$page->_action) {
- $page = $page->move($this->parent());
- $page->order($counter);
- $page->save(false);
- }
- }
- }
- }
- }
- }
- /**
- * Moves or copies the page in filesystem.
- *
- * @internal
- *
- * @throws \Exception
- */
- protected function doRelocation()
- {
- if (!$this->_original) {
- return;
- }
- if (is_dir($this->_original->path())) {
- if ($this->_action === 'move') {
- Folder::move($this->_original->path(), $this->path());
- } elseif ($this->_action === 'copy') {
- Folder::copy($this->_original->path(), $this->path());
- }
- }
- if ($this->name() !== $this->_original->name()) {
- $path = $this->path();
- if (is_file($path . '/' . $this->_original->name())) {
- rename($path . '/' . $this->_original->name(), $path . '/' . $this->name());
- }
- }
- }
- protected function setPublishState()
- {
- // Handle publishing dates if no explicit published option set
- if (Grav::instance()['config']->get('system.pages.publish_dates') && !isset($this->header->published)) {
- // unpublish if required, if not clear cache right before page should be unpublished
- if ($this->unpublishDate()) {
- if ($this->unpublishDate() < time()) {
- $this->published(false);
- } else {
- $this->published();
- Grav::instance()['cache']->setLifeTime($this->unpublishDate());
- }
- }
- // publish if required, if not clear cache right before page is published
- if ($this->publishDate() && $this->publishDate() > time()) {
- $this->published(false);
- Grav::instance()['cache']->setLifeTime($this->publishDate());
- }
- }
- }
- protected function adjustRouteCase($route)
- {
- $case_insensitive = Grav::instance()['config']->get('system.force_lowercase_urls');
- return $case_insensitive ? mb_strtolower($route) : $route;
- }
- /**
- * Gets the Page Unmodified (original) version of the page.
- *
- * @return PageInterface The original version of the page.
- */
- public function getOriginal()
- {
- return $this->_original;
- }
- /**
- * Gets the action.
- *
- * @return string The Action string.
- */
- public function getAction()
- {
- return $this->_action;
- }
- }
|