Skip to content

Commit

Permalink
php-cs-fixer
Browse files Browse the repository at this point in the history
  • Loading branch information
mlocati committed Oct 3, 2016
1 parent d95837d commit 11ca059
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 38 deletions.
32 changes: 16 additions & 16 deletions src/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@ public function canParseDirectory()
/**
* Extracts translations from a directory.
*
* @param string $rootDirectory The base directory where we start looking translations from.
* @param string $relativePath The relative path (translations references will be prepended with this path).
* @param \Gettext\Translations|null=null $translations The translations object where the translatable strings will be added (if null we'll create a new Translations instance).
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers).
* @param string $rootDirectory The base directory where we start looking translations from
* @param string $relativePath The relative path (translations references will be prepended with this path)
* @param \Gettext\Translations|null=null $translations The translations object where the translatable strings will be added (if null we'll create a new Translations instance)
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers)
* @param bool $exclude3rdParty Exclude concrete5 3rd party directories (namely directories called 'vendor' and '3rdparty')
*
* @throws \Exception Throws an \Exception in case of errors.
* @throws \Exception Throws an \Exception in case of errors
*
* @return \Gettext\Translations
*
* @example If you want to parse the concrete5 core directory, you should call `parseDirectory('PathToTheWebroot/concrete', 'concrete')`.
* @example If you want to parse a concrete5 package, you should call `parseDirectory('PathToThePackageFolder', 'packages/YourPackageHandle')`.
* @example If you want to parse the concrete5 core directory, you should call `parseDirectory('PathToTheWebroot/concrete', 'concrete')`
* @example If you want to parse a concrete5 package, you should call `parseDirectory('PathToThePackageFolder', 'packages/YourPackageHandle')`
*/
final public function parseDirectory($rootDirectory, $relativePath, $translations = null, $subParsersFilter = false, $exclude3rdParty = true)
{
Expand Down Expand Up @@ -89,10 +89,10 @@ final public function parseDirectory($rootDirectory, $relativePath, $translation
* Final implementation of {@link \C5TL\Parser::parseDirectory()}.
*
* @param \Gettext\Translations $translations Found translatable strings will be appended here
* @param string $rootDirectory The base directory where we start looking translations from.
* @param string $relativePath The relative path (translations references will be prepended with this path).
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers).
* @param bool $exclude3rdParty Exclude concrete5 3rd party directories (namely directories called 'vendor' and '3rdparty').
* @param string $rootDirectory The base directory where we start looking translations from
* @param string $relativePath The relative path (translations references will be prepended with this path)
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers)
* @param bool $exclude3rdParty Exclude concrete5 3rd party directories (namely directories called 'vendor' and '3rdparty')
*/
protected function parseDirectoryDo(\Gettext\Translations $translations, $rootDirectory, $relativePath, $subParsersFilter, $exclude3rdParty)
{
Expand All @@ -112,10 +112,10 @@ public function canParseRunningConcrete5()
/**
* Extracts translations from a running concrete5 instance.
*
* @param \Gettext\Translations|null=null $translations The translations object where the translatable strings will be added (if null we'll create a new Translations instance).
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers).
* @param \Gettext\Translations|null=null $translations The translations object where the translatable strings will be added (if null we'll create a new Translations instance)
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers)
*
* @throws \Exception Throws an \Exception in case of errors.
* @throws \Exception Throws an \Exception in case of errors
*
* @return \Gettext\Translations
*/
Expand All @@ -140,8 +140,8 @@ final public function parseRunningConcrete5($translations = null, $subParsersFil
* Final implementation of {@link \C5TL\Parser::parseRunningConcrete5()}.
*
* @param \Gettext\Translations $translations Found translatable strings will be appended here
* @param string $concrete5version The version of the running concrete5 instance.
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers).
* @param string $concrete5version The version of the running concrete5 instance
* @param array|false $subParsersFilter A list of sub-parsers handles (set to false to use all the sub-parsers)
*/
protected function parseRunningConcrete5Do(\Gettext\Translations $translations, $concrete5version, $subParsersFilter)
{
Expand Down
36 changes: 18 additions & 18 deletions src/Parser/Cif.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ private static function parseXml(\Gettext\Translations $translations, $realPath,
}

/** Parse an xml node and retrieves any associated POEntry.
* @param \Gettext\Translations $translations Will be populated with found entries.
* @param string $filenameRel The relative file name of the xml file being read.
* @param \DOMNode $node The current node.
* @param string $prePath The path of the node containing the current node.
* @param \Gettext\Translations $translations Will be populated with found entries
* @param string $filenameRel The relative file name of the xml file being read
* @param \DOMNode $node The current node
* @param string $prePath The path of the node containing the current node
*
* @throws \Exception Throws an \Exception in case of errors.
* @throws \Exception Throws an \Exception in case of errors
*/
private static function parseXmlNode(\Gettext\Translations $translations, $filenameRel, \DOMNode $node, $prePath)
{
Expand Down Expand Up @@ -387,11 +387,11 @@ private static function parseXmlNode(\Gettext\Translations $translations, $filen
}

/** Parse a node attribute and create a POEntry item if it has a value.
* @param \Gettext\Translations $translations Will be populated with found entries.
* @param string $filenameRel The relative file name of the xml file being read.
* @param \DOMNode $node The current node.
* @param string $attributeName The name of the attribute.
* @param string $context='' The translation context.
* @param \Gettext\Translations $translations Will be populated with found entries
* @param string $filenameRel The relative file name of the xml file being read
* @param \DOMNode $node The current node
* @param string $attributeName The name of the attribute
* @param string $context='' The translation context
*/
private static function readXmlNodeAttribute(\Gettext\Translations $translations, $filenameRel, \DOMNode $node, $attributeName, $context = '')
{
Expand All @@ -403,10 +403,10 @@ private static function readXmlNodeAttribute(\Gettext\Translations $translations
}

/** Parse a node attribute which contains the keywords for a page.
* @param \Gettext\Translations $translations Will be populated with found entries.
* @param string $filenameRel The relative file name of the xml file being read.
* @param \DOMNode $node The current node.
* @param string $pageUrl The url of the page for which the keywords are for.
* @param \Gettext\Translations $translations Will be populated with found entries
* @param string $filenameRel The relative file name of the xml file being read
* @param \DOMNode $node The current node
* @param string $pageUrl The url of the page for which the keywords are for
*/
private static function readXmlPageKeywords(\Gettext\Translations $translations, $filenameRel, \DOMNode $node, $pageUrl)
{
Expand All @@ -424,10 +424,10 @@ private static function readXmlPageKeywords(\Gettext\Translations $translations,
/**
* Parse a node value and create a POEntry item if it has a value.
*
* @param \Gettext\Translations $translations Will be populated with found entries.
* @param string $filenameRel The relative file name of the xml file being read.
* @param \DOMNode $node The current node.
* @param string $context='' The translation context.
* @param \Gettext\Translations $translations Will be populated with found entries
* @param string $filenameRel The relative file name of the xml file being read
* @param \DOMNode $node The current node
* @param string $context='' The translation context
*/
private static function parseXmlNodeValue(\Gettext\Translations $translations, $filenameRel, \DOMNode $node, $context = '')
{
Expand Down
8 changes: 4 additions & 4 deletions src/Parser/DynamicItem/DynamicItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ abstract public function getParsedItemNames();
/**
* Extract specific items from the running concrete5.
*
* @param \Gettext\Translations $translations Found translations will be appended here.
* @param string $concrete5version The version of the running concrete5 instance.
* @param \Gettext\Translations $translations Found translations will be appended here
* @param string $concrete5version The version of the running concrete5 instance
*/
final public function parse(\Gettext\Translations $translations, $concrete5version)
{
Expand All @@ -41,8 +41,8 @@ protected function getClassNameForExtractor()
/**
* Manual parsing of items.
*
* @param \Gettext\Translations $translations Found translations will be appended here.
* @param string $concrete5version The version of the running concrete5 instance.
* @param \Gettext\Translations $translations Found translations will be appended here
* @param string $concrete5version The version of the running concrete5 instance
*/
protected function parseManual(\Gettext\Translations $translations, $concrete5version)
{
Expand Down

0 comments on commit 11ca059

Please sign in to comment.