Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aimeos committed Sep 17, 2017
1 parent dde8885 commit 4f5586c
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 16 deletions.
10 changes: 5 additions & 5 deletions lib/mshoplib/src/MShop/Context/Item/Iface.php
Expand Up @@ -46,7 +46,7 @@ public function setConfig( \Aimeos\MW\Config\Iface $config );
/**
* Returns the configuration object.
*
* @return \Aimeos\MShop\Config\Iface Configuration object
* @return \Aimeos\MW\Config\Iface Configuration object
*/
public function getConfig();

Expand Down Expand Up @@ -169,8 +169,8 @@ public function getMessageQueueManager();
* Returns the message queue object.
*
* @param string $resource Resource name, e.g. "mq-email"
* @apram string $queue Message queue name, e.g. "order/email/payment"
* @return \Aimeos\MW\Queue\Manager\Iface Message queue object
* @param string $queue Message queue name, e.g. "order/email/payment"
* @return \Aimeos\MW\MQueue\Queue\Iface Message queue object
*/
public function getMessageQueue( $resource, $queue );

Expand Down Expand Up @@ -222,15 +222,15 @@ public function getView();
/**
* Sets the account name of the user/editor.
*
* @param string $name Account name of the user/editor
* @param string $name Account name or IP address of the user/editor
* @return \Aimeos\MShop\Context\Item\Iface Context item for chaining method calls
*/
public function setEditor( $name );

/**
* Returns the account name of the user/editor.
*
* @return string Account name of the user/editor
* @return string Account name or IP address of the user/editor
*/
public function getEditor();

Expand Down
2 changes: 1 addition & 1 deletion lib/mwlib/src/MW/View/Helper/Content/Iface.php
Expand Up @@ -12,7 +12,7 @@


/**
* View helper class for retrieving configuration values.
* View helper class for generating media URLs
*
* @package MW
* @subpackage View
Expand Down
4 changes: 2 additions & 2 deletions lib/mwlib/src/MW/View/Helper/Session/Iface.php
Expand Up @@ -22,9 +22,9 @@ interface Iface extends \Aimeos\MW\View\Helper\Iface
/**
* Returns the session value.
*
* @param string|null $name Name of the session key
* @param string $name Name of the session key
* @param mixed $default Default value if session key is not available
* @return mixed Session value
*/
public function transform( $name = null, $default = null );
public function transform( $name, $default = null );
}
4 changes: 2 additions & 2 deletions lib/mwlib/src/MW/View/Helper/Session/Standard.php
Expand Up @@ -41,11 +41,11 @@ public function __construct( $view, \Aimeos\MW\Session\Iface $session )
/**
* Returns the session value.
*
* @param string|null $name Name of the session key
* @param string $name Name of the session key
* @param mixed $default Default value if session key is not available
* @return mixed Session value
*/
public function transform( $name = null, $default = null )
public function transform( $name, $default = null )
{
return $this->session->get( $name, $default );
}
Expand Down
18 changes: 12 additions & 6 deletions lib/mwlib/src/MW/View/Iface.php
Expand Up @@ -15,18 +15,24 @@
/**
* Common interface for all view classes.
*
* @method boolean access(string|array $groups) True if the current logged in user is in one of the given groups
* @method \Aimeos\MW\View\Helper\Block\Iface block() Returns the block helper object
* @method mixed config(string $name = null, string|array $default = null) Returns the config value for the given key
* @method \Aimeos\MW\View\Helper\Iface csrf() Returns the CSRF helper object
* @method string content(string $path) Returns the URL for the given path (relative, absolute or data URL)
* @method \Aimeos\MW\View\Helper\Csrf\Iface csrf() Returns the CSRF helper object
* @method string date(string $date) Returns the formatted date
* @method \Aimeos\MW\View\Helper\Iface encoder() Returns the encoder helper object
* @method \Aimeos\MW\View\Helper\Encoder\Iface encoder() Returns the encoder helper object
* @method string formparam(string|array $names) Returns the name for the HTML form parameter
* @method \Aimeos\MW\Mail\Message\Iface mail() Returns the e-mail message object
* @method string number(integer|float|decimal $number, integer $decimals = 2) Returns the formatted number
* @method string|array param(string|null $name, string|array $default) Returns the parameter value
* @method string partial(string $filepath, array $params = [] ) Renders the partial template
* @method \Aimeos\MW\View\Helper\Iface request() Returns the request helper object
* @method string number(integer|float|decimal $number, integer $decimals = null) Returns the formatted number
* @method string|array param(string|null $name, string|array $default) Parameter value or associative list of key/value pairs
* @method string partial(string $filepath, array $params = []) Renders the rendered partial template
* @method \Aimeos\MW\View\Helper\Request\Iface request() Returns the request view helper object
* @method \Aimeos\MW\View\Helper\Response\Iface response() Returns the response view helper object
* @method mixed session($name, $default = null) Returns the session value for the given name
* @method string translate(string $domain, string $singular, string $plural = '', integer $number = 1) Returns the translated string or the original one if no translation is available
* @method string url(string|null $target, string|null $controller = null, string|null $action = null, array $params = [], array $trailing = [], array $config = []) Returns the URL assembled from the given arguments
* @method mixed value(array $values, $key, $default = null) Returns the value for the given key in the array
*
* @package MW
* @subpackage View
Expand Down

0 comments on commit 4f5586c

Please sign in to comment.