Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Translation\Extractor;
Chris@0: 
Chris@0: use Symfony\Component\Translation\Exception\InvalidArgumentException;
Chris@0: 
Chris@0: /**
Chris@0:  * Base class used by classes that extract translation messages from files.
Chris@0:  *
Chris@0:  * @author Marcos D. Sánchez <marcosdsanchez@gmail.com>
Chris@0:  */
Chris@0: abstract class AbstractFileExtractor
Chris@0: {
Chris@0:     /**
Chris@14:      * @param string|array $resource Files, a file or a directory
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     protected function extractFiles($resource)
Chris@0:     {
Chris@17:         if (\is_array($resource) || $resource instanceof \Traversable) {
Chris@17:             $files = [];
Chris@0:             foreach ($resource as $file) {
Chris@0:                 if ($this->canBeExtracted($file)) {
Chris@0:                     $files[] = $this->toSplFileInfo($file);
Chris@0:                 }
Chris@0:             }
Chris@0:         } elseif (is_file($resource)) {
Chris@17:             $files = $this->canBeExtracted($resource) ? [$this->toSplFileInfo($resource)] : [];
Chris@0:         } else {
Chris@0:             $files = $this->extractFromDirectory($resource);
Chris@0:         }
Chris@0: 
Chris@0:         return $files;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $file
Chris@0:      *
Chris@0:      * @return \SplFileInfo
Chris@0:      */
Chris@0:     private function toSplFileInfo($file)
Chris@0:     {
Chris@0:         return ($file instanceof \SplFileInfo) ? $file : new \SplFileInfo($file);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $file
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException
Chris@0:      */
Chris@0:     protected function isFile($file)
Chris@0:     {
Chris@0:         if (!is_file($file)) {
Chris@0:             throw new InvalidArgumentException(sprintf('The "%s" file does not exist.', $file));
Chris@0:         }
Chris@0: 
Chris@0:         return true;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $file
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     abstract protected function canBeExtracted($file);
Chris@0: 
Chris@0:     /**
Chris@14:      * @param string|array $resource Files, a file or a directory
Chris@0:      *
Chris@0:      * @return array files to be extracted
Chris@0:      */
Chris@0:     abstract protected function extractFromDirectory($resource);
Chris@0: }