Skip to content

Fix RendererInterface default params #4093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Fix RendererInterface default params #4093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06b3838
fix: $saveData default value
kenjis Jan 11, 2021
02ee95c
docs: fix @param type
kenjis Jan 11, 2021
02ef6a1
docs: fix phpdoc indentation
kenjis Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions system/View/RendererInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,35 @@ interface RendererInterface
* Builds the output based upon a file name and any
* data that has already been set.
*
* @param string $view
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
* @param string $view
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean|null $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
*
* @return string
*/
public function render(string $view, array $options = null, bool $saveData = false): string;
public function render(string $view, array $options = null, bool $saveData = null): string;

//--------------------------------------------------------------------

/**
* Builds the output based upon a string and any
* data that has already been set.
*
* @param string $view The view contents
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
* @param string $view The view contents
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean|null $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
*
* @return string
*/
public function renderString(string $view, array $options = null, bool $saveData = false): string;
public function renderString(string $view, array $options = null, bool $saveData = null): string;

//--------------------------------------------------------------------

Expand Down
16 changes: 8 additions & 8 deletions system/View/View.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public function __construct(ViewConfig $config, string $viewPath = null, FileLoc
* data that has already been set.
*
* Valid $options:
* - cache number of seconds to cache for
* - cache number of seconds to cache for
* - cache_name Name to use for cache
*
* @param string $view
Expand Down Expand Up @@ -272,13 +272,13 @@ public function render(string $view, array $options = null, bool $saveData = nul
* data that has already been set.
* Cache does not apply, because there is no "key".
*
* @param string $view The view contents
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
* @param string $view The view contents
* @param array $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param boolean|null $saveData If true, will save data for use with any other calls,
* if false, will clean the data after displaying the view,
* if not specified, use the config setting.
*
* @return string
*/
Expand Down