├── COPYING.txt
├── LICENSE
├── composer.json
└── src
    ├── Acl
        ├── Acl.php
        ├── Contracts
        │   └── Aclable.php
        └── Traits
        │   └── HasAcl.php
    ├── Categories
        ├── Category.php
        ├── CategorySearcher.php
        ├── Column.php
        ├── Command
        │   └── CreateRootCategory.php
        ├── Search
        │   └── CategorySearch.php
        ├── Traits
        │   ├── HasCategories.php
        │   └── HasCategory.php
        └── Validation
        │   └── CategoryValidator.php
    ├── Collection.php
    ├── Command
        ├── BaseCommand.php
        ├── Contracts
        │   └── CommandInterface.php
        ├── Database
        │   ├── DropTable.php
        │   ├── EmptyTable.php
        │   └── ExecuteSQLFile.php
        └── FileSystem
        │   └── DeleteFolderRecursively.php
    ├── ComponentEntity.php
    ├── Content
        ├── Article.php
        ├── Category.php
        ├── Command
        │   └── CreateUncategorisedCategory.php
        ├── ContentType.php
        ├── Controller
        │   └── ArticlesController.php
        ├── Entity
        │   ├── Article.php
        │   └── Category.php
        ├── Model
        │   └── ArticlesModel.php
        ├── Search
        │   ├── ArticleSearch.php
        │   └── CategorySearch.php
        ├── Traits
        │   ├── HasArticle.php
        │   └── HasArticles.php
        └── Validation
        │   └── ArticleValidator.php
    ├── Contracts
        ├── AssociatedEntity.php
        ├── ComponentEntityInterface.php
        ├── EntityInterface.php
        └── ExceptionInterface.php
    ├── Core
        ├── Client
        │   ├── Administrator.php
        │   ├── BaseClient.php
        │   ├── Client.php
        │   ├── ClientInterface.php
        │   └── Site.php
        ├── Command
        │   └── CreateRootAsset.php
        ├── Contracts
        │   └── Publishable.php
        ├── CoreColumn.php
        ├── Entity
        │   ├── Asset.php
        │   └── Module.php
        └── Traits
        │   ├── HasAccess.php
        │   ├── HasAncestors.php
        │   ├── HasAsset.php
        │   ├── HasAssociations.php
        │   ├── HasChildren.php
        │   ├── HasClient.php
        │   ├── HasDescendants.php
        │   ├── HasEvents.php
        │   ├── HasFeatured.php
        │   ├── HasImages.php
        │   ├── HasInstances.php
        │   ├── HasLevel.php
        │   ├── HasLink.php
        │   ├── HasLinks.php
        │   ├── HasMetadata.php
        │   ├── HasParams.php
        │   ├── HasParent.php
        │   ├── HasPublishDown.php
        │   ├── HasPublishUp.php
        │   ├── HasSingleton.php
        │   ├── HasState.php
        │   └── HasUrls.php
    ├── Decorator.php
    ├── Entity.php
    ├── Exception
        ├── DeleteException.php
        ├── InvalidEntityData.php
        ├── LoadEntityDataError.php
        └── SaveException.php
    ├── Extensions
        └── Entity
        │   ├── ActiveComponent.php
        │   ├── Component.php
        │   ├── Extension.php
        │   └── Traits
        │       └── HasComponent.php
    ├── Fields
        ├── Column.php
        ├── Field.php
        ├── FieldGroup.php
        └── Traits
        │   └── HasFields.php
    ├── Helper
        ├── ArrayHelper.php
        └── ClassName.php
    ├── Installer
        └── DependencyInstaller.php
    ├── MVC
        ├── Controller
        │   ├── AdminController.php
        │   ├── FormController.php
        │   └── Traits
        │   │   ├── HasAssociatedEntity.php
        │   │   ├── HasEntityCreate.php
        │   │   ├── HasEntityDelete.php
        │   │   ├── HasEntityGet.php
        │   │   ├── HasEntitySave.php
        │   │   ├── HasEntitySearch.php
        │   │   └── HasEntityUpdate.php
        ├── JSONResponse.php
        ├── Model
        │   ├── AdminModel.php
        │   ├── ListModel.php
        │   ├── ModelWithStateInterface.php
        │   ├── QueryModifier
        │   │   ├── BaseQueryModifier.php
        │   │   ├── DateGreaterInColumn.php
        │   │   ├── DateGreaterOrEqualInColumn.php
        │   │   ├── DateLowerInColumn.php
        │   │   ├── DateLowerOrEqualInColumn.php
        │   │   ├── DateRangeInColumn.php
        │   │   ├── NotEmptyColumn.php
        │   │   ├── NotNullInColumn.php
        │   │   ├── NullInColumn.php
        │   │   ├── QueryModifierInterface.php
        │   │   ├── SearchInColumns.php
        │   │   ├── ValuesInColumn.php
        │   │   └── ValuesNotInColumn.php
        │   ├── State
        │   │   ├── Filter
        │   │   │   ├── BaseFilter.php
        │   │   │   ├── Boolean.php
        │   │   │   ├── Custom.php
        │   │   │   ├── DateFilter.php
        │   │   │   ├── DateRangeFilter.php
        │   │   │   ├── DateTimeFilter.php
        │   │   │   ├── Escaped.php
        │   │   │   ├── FilterInterface.php
        │   │   │   ├── Integer.php
        │   │   │   ├── IntegerBoolean.php
        │   │   │   ├── PositiveInteger.php
        │   │   │   ├── StringFilter.php
        │   │   │   └── StringQuoted.php
        │   │   ├── FilteredProperty.php
        │   │   ├── FilteredState.php
        │   │   ├── PopulableProperty.php
        │   │   ├── Property.php
        │   │   ├── PropertyInterface.php
        │   │   ├── State.php
        │   │   └── StateInterface.php
        │   └── Traits
        │   │   ├── HasContext.php
        │   │   ├── HasFilteredState.php
        │   │   ├── HasQueryModifiers.php
        │   │   └── HasSearch.php
        ├── Request.php
        ├── ResponseStatus.php
        └── View
        │   ├── FormView.php
        │   ├── HTMLView.php
        │   ├── ItemFormView.php
        │   ├── ItemView.php
        │   ├── ListView.php
        │   └── Traits
        │       └── HasAssociatedEntity.php
    ├── Messages
        └── Message.php
    ├── Routing
        └── RouteGenerator.php
    ├── Searcher
        ├── BaseSearcher.php
        ├── DatabaseSearcher.php
        └── SearcherInterface.php
    ├── Table
        ├── AbstractNestedTable.php
        ├── AbstractTable.php
        ├── TableFinder.php
        ├── TableInterface.php
        └── Traits
        │   ├── HasAsset.php
        │   ├── HasAutoEvents.php
        │   ├── HasCommonChecks.php
        │   ├── HasFixedGetProperties.php
        │   ├── HasInstanceName.php
        │   ├── HasInstancePrefix.php
        │   ├── HasKeysComparator.php
        │   └── HasLanguageStrings.php
    ├── Tags
        ├── Search
        │   └── TagSearch.php
        ├── Tag.php
        └── Traits
        │   └── HasTags.php
    ├── Traits
        ├── HasApp.php
        ├── HasLayoutData.php
        ├── HasMailer.php
        ├── HasMessages.php
        ├── HasRedirect.php
        └── HasStaticCache.php
    ├── Translation
        ├── Contracts
        │   ├── Translatable.php
        │   └── Translator.php
        ├── Traits
        │   └── HasTranslations.php
        ├── Translator.php
        └── TranslatorWithFallback.php
    ├── Users
        ├── AuthorUserGroup.php
        ├── Column.php
        ├── Command
        │   ├── CreatePredefinedUserGroups.php
        │   └── CreatePredefinedViewLevels.php
        ├── Contracts
        │   └── Ownerable.php
        ├── GuestUserGroup.php
        ├── GuestViewLevel.php
        ├── ManagerUserGroup.php
        ├── PredefinedUserGroup.php
        ├── PredefinedViewLevel.php
        ├── PublicUserGroup.php
        ├── PublicViewLevel.php
        ├── RegisteredUserGroup.php
        ├── RegisteredViewLevel.php
        ├── Search
        │   └── UserSearch.php
        ├── SpecialViewLevel.php
        ├── SuperUsersUserGroup.php
        ├── SuperUsersViewLevel.php
        ├── Traits
        │   ├── HasAuthor.php
        │   ├── HasEditor.php
        │   ├── HasOwner.php
        │   ├── HasUser.php
        │   ├── HasUserGroups.php
        │   ├── HasUsers.php
        │   └── HasViewLevels.php
        ├── User.php
        ├── UserGroup.php
        └── ViewLevel.php
    └── Validation
        ├── Contracts
            ├── Rule.php
            ├── Validable.php
            └── Validator.php
        ├── Exception
            └── ValidationException.php
        ├── Rule.php
        ├── Rule
            ├── CustomRule.php
            ├── IsEmptyDate.php
            ├── IsEmptyString.php
            ├── IsInteger.php
            ├── IsNegativeInteger.php
            ├── IsNotEmptyDate.php
            ├── IsNotEmptyString.php
            ├── IsNotNull.php
            ├── IsNull.php
            ├── IsNullOrEmptyString.php
            ├── IsNullOrPositiveInteger.php
            ├── IsPositiveInteger.php
            ├── IsString.php
            ├── IsZeroOrPositiveInteger.php
            ├── NoSubstrCount.php
            └── SubstrCount.php
        ├── Traits
            └── HasValidation.php
        └── Validator.php


/COPYING.txt:
--------------------------------------------------------------------------------
1 | Copyright © 2017 Roberto Segura López
2 | 
3 | Each file included in this library is licensed under GNU LESSER GENERAL PUBLIC LICENSE
4 | 
5 | See LICENSE for the full text of the GNU LESSER GENERAL PUBLIC LICENSE.
6 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "phproberto/joomla-entity",
 3 |   "description": "Entities for Joomla!",
 4 |   "keywords": ["joomla", "entity", "orm"],
 5 |   "homepage": "https://github.com/phproberto/joomla-entity",
 6 |   "license": "LGPL-2.1+",
 7 |   "authors": [
 8 |       {
 9 |           "name": "Roberto Segura López",
10 |           "email": "roberto@phproberto.com",
11 |           "homepage": "http://phproberto.com"
12 |       }
13 |   ],
14 |   "config": {
15 |     "process-timeout":0
16 |   },
17 |   "require": {
18 |     "php": "^7.0"
19 |   },
20 |   "autoload": {
21 |     "psr-4": {
22 |       "Phproberto\\Joomla\\Entity\\": "src/"
23 |     }
24 |   },
25 |   "autoload-dev": {
26 |       "psr-4": {
27 |           "Phproberto\\Joomla\\Entity\\Tests\\": "tests/tests"
28 |       }
29 |   },
30 |   "require-dev": {
31 |     "phpunit/phpunit": "^4.8.35",
32 |     "joomla/coding-standards": "~2.0@alpha",
33 |     "squizlabs/php_codesniffer": "^2.8"
34 |   },
35 |   "extra": {
36 |       "branch-alias": {
37 |           "dev-master": "2.0-dev"
38 |       }
39 |   },
40 |   "scripts": {
41 |     "clean"            : "cd ./build && gulp clean",
42 |     "copy"             : "cd ./build && gulp copy",
43 |     "cs"               : "./vendor/bin/phpcs",
44 |     "dev"              : "cd ./build && gulp",
45 |     "release"          : "cd ./build && gulp release",
46 |     "setup"            : "cd ./build && npm install && cp gulp-config.dist.json gulp-config.json",
47 |     "test"             : "./vendor/bin/phpunit",
48 |     "testFailFast"     : "./vendor/bin/phpunit --stop-on-failure",
49 |     "testWithCoverage" : "./vendor/bin/phpunit --coverage-html tests/coverage",
50 |     "watch"            : "cd ./build && gulp watch"
51 |   }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Acl/Contracts/Aclable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Acl\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by entities with ACL support.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | interface Aclable
19 | {
20 | 	/**
21 | 	 * Get the ACL prefix applied to this entity
22 | 	 *
23 | 	 * @return  string
24 | 	 */
25 | 	public function aclPrefix();
26 | 
27 | 	/**
28 | 	 * Get the identifier of the associated asset
29 | 	 *
30 | 	 * @return  string
31 | 	 */
32 | 	public function aclAssetName();
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Acl/Traits/HasAcl.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Acl\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\User;
14 | use Phproberto\Joomla\Entity\Acl\Acl;
15 | 
16 | /**
17 |  * Trait for entities with ACL.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | trait HasAcl
22 | {
23 | 	/**
24 | 	 * Acl instance.
25 | 	 *
26 | 	 * @param   User|null  $user  User to check ACL against.
27 | 	 *
28 | 	 * @return  Acl
29 | 	 */
30 | 	public function acl(User $user = null)
31 | 	{
32 | 		return new Acl($this, $user);
33 | 	}
34 | 
35 | 	/**
36 | 	 * Get the ACL prefix applied to this entity
37 | 	 *
38 | 	 * @return  string
39 | 	 */
40 | 	public function aclPrefix()
41 | 	{
42 | 		return 'core';
43 | 	}
44 | 
45 | 	/**
46 | 	 * Get the identifier of the associated asset
47 | 	 *
48 | 	 * @return  string
49 | 	 */
50 | 	public function aclAssetName()
51 | 	{
52 | 		if ($this->hasId())
53 | 		{
54 | 			return $this->component()->option() . '.' . $this->name() . '.' . $this->id();
55 | 		}
56 | 
57 | 		return $this->component()->option();
58 | 	}
59 | }
60 | 


--------------------------------------------------------------------------------
/src/Categories/CategorySearcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Categories;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Categories\Search\CategorySearch;
14 | 
15 | /**
16 |  * Category searcher.
17 |  *
18 |  * @since       1.4.0
19 |  * @deprecated  1.6.0  Use CategorySearch
20 |  */
21 | class CategorySearcher extends CategorySearch
22 | {
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Categories/Column.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Categories;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Columns supported by categories.
15 |  *
16 |  * @since   1.7.2
17 |  */
18 | abstract class Column
19 | {
20 | 	/**
21 | 	 * Default column used to store category.
22 | 	 *
23 | 	 * @const
24 | 	 */
25 | 	const CATEGORY = 'category_id';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Categories/Command/CreateRootCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Categories\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Categories\Category;
15 | use Phproberto\Joomla\Entity\Command\BaseCommand;
16 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
17 | 
18 | /**
19 |  * Create the root category.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | class CreateRootCategory extends BaseCommand implements CommandInterface
24 | {
25 | 	/**
26 | 	 * Execute the command.
27 | 	 *
28 | 	 * @return  Category
29 | 	 */
30 | 	public function execute()
31 | 	{
32 | 		$db = Factory::getDbo();
33 | 
34 | 		$data = [
35 | 			'lft'       => 0,
36 | 			'rgt'       => 1,
37 | 			'level'     => 0,
38 | 			'extension' => $db->q('system'),
39 | 			'title'     => $db->q('ROOT'),
40 | 			'alias'     => $db->q('root'),
41 | 			'published' => 1,
42 | 			'access'    => 1
43 | 		];
44 | 
45 | 		$query = $db->getQuery(true)
46 | 			->insert($db->qn('#__categories'))
47 | 			->columns(array_keys($data))
48 | 			->values(implode(',', array_values($data)));
49 | 
50 | 		$db->setQuery($query);
51 | 
52 | 		if (!$db->execute())
53 | 		{
54 | 			throw new \RuntimeException("Error creating root category: " . $db->stderr(true));
55 | 		}
56 | 
57 | 		return Category::find($db->insertid());
58 | 	}
59 | }
60 | 


--------------------------------------------------------------------------------
/src/Categories/Traits/HasCategories.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Categories\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Categories\Category;
14 | 
15 | /**
16 |  * Trait for entities that have associated categories.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | trait HasCategories
21 | {
22 | 	/**
23 | 	 * Associated categories.
24 | 	 *
25 | 	 * @var  Collection
26 | 	 */
27 | 	protected $categories;
28 | 
29 | 	/**
30 | 	 * Get the associated categories.
31 | 	 *
32 | 	 * @param   boolean  $reload  Force data reloading
33 | 	 *
34 | 	 * @return  Collection
35 | 	 */
36 | 	public function categories($reload = false)
37 | 	{
38 | 		if ($reload || null === $this->categories)
39 | 		{
40 | 			$this->categories = $this->loadCategories();
41 | 		}
42 | 
43 | 		return $this->categories;
44 | 	}
45 | 
46 | 	/**
47 | 	 * Clear already loaded categories.
48 | 	 *
49 | 	 * @return  self
50 | 	 */
51 | 	public function clearCategories()
52 | 	{
53 | 		$this->categories = null;
54 | 
55 | 		return $this;
56 | 	}
57 | 
58 | 	/**
59 | 	 * Check if this entity has an associated category.
60 | 	 *
61 | 	 * @param   integer   $id  Category identifier
62 | 	 *
63 | 	 * @return  boolean
64 | 	 */
65 | 	public function hasCategory($id)
66 | 	{
67 | 		return $this->categories()->has($id);
68 | 	}
69 | 
70 | 	/**
71 | 	 * Check if this entity has associated categories.
72 | 	 *
73 | 	 * @return  boolean
74 | 	 */
75 | 	public function hasCategories()
76 | 	{
77 | 		return !$this->categories()->isEmpty();
78 | 	}
79 | 
80 | 	/**
81 | 	 * Load associated categories from DB.
82 | 	 *
83 | 	 * @return  Collection
84 | 	 */
85 | 	abstract protected function loadCategories();
86 | }
87 | 


--------------------------------------------------------------------------------
/src/Categories/Validation/CategoryValidator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Categories\Validation;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Categories\Category;
14 | use Phproberto\Joomla\Entity\Validation\Validator;
15 | use Phproberto\Joomla\Entity\Validation\Rule;
16 | 
17 | /**
18 |  * Category validator.
19 |  *
20 |  * @since  1.7.0
21 |  */
22 | class CategoryValidator extends Validator
23 | {
24 | 	/**
25 | 	 * Constructor.
26 | 	 *
27 | 	 * @param   Article  $article  Article to validate.
28 | 	 */
29 | 	public function __construct(Category $article)
30 | 	{
31 | 		parent::__construct($article);
32 | 
33 | 		$this->addRules(
34 | 			[
35 | 				'access'    => new Rule\IsNullOrPositiveInteger('Valid view level identifier'),
36 | 				'extension' => new Rule\IsNotEmptyString('Not empty extension'),
37 | 				'level'     => new Rule\IsNullOrPositiveInteger('Valid level'),
38 | 				'parent_id' => new Rule\IsNullOrPositiveInteger('Valid parent'),
39 | 				'title'     => new Rule\IsNotEmptyString('Not empty title')
40 | 			]
41 | 		);
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Command/BaseCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\Registry\Registry;
14 | 
15 | /**
16 |  * Base Command.
17 |  *
18 |  * @since  1.8
19 |  */
20 | abstract class BaseCommand
21 | {
22 | 	/**
23 | 	 * Command extra configuration.
24 | 	 *
25 | 	 * @var  Registry
26 | 	 */
27 | 	protected $config;
28 | 
29 | 	/**
30 | 	 * Constructor.
31 | 	 *
32 | 	 * @param   array  $options  Array with command options
33 | 	 */
34 | 	public function __construct(array $options = [])
35 | 	{
36 | 		$this->config = new Registry($options);
37 | 	}
38 | 
39 | 	/**
40 | 	 * Factory method.
41 | 	 *
42 | 	 * @param   array   $arguments  Arguments for the instance.
43 | 	 *
44 | 	 * @return  static
45 | 	 */
46 | 	public static function instance(array $arguments = [])
47 | 	{
48 | 		return (new \ReflectionClass(get_called_class()))->newInstanceArgs($arguments);
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Command/Contracts/CommandInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by commands.
15 |  *
16 |  * @since  1.8
17 |  */
18 | interface CommandInterface
19 | {
20 | 	/**
21 | 	 * Execute the command.
22 | 	 *
23 | 	 * @return  mixed
24 | 	 */
25 | 	public function execute();
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Command/Database/DropTable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command\Database;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Command\BaseCommand;
15 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
16 | 
17 | /**
18 |  * Drop a database table.
19 |  *
20 |  * @since  1.8
21 |  */
22 | final class DropTable extends BaseCommand implements CommandInterface
23 | {
24 | 	/**
25 | 	 * Database driver.
26 | 	 *
27 | 	 * @var  \JDatabaseDriver
28 | 	 */
29 | 	private $db;
30 | 
31 | 	/**
32 | 	 * Name of the table to drop.
33 | 	 *
34 | 	 * @var  string
35 | 	 */
36 | 	private $tableName;
37 | 
38 | 	/**
39 | 	 * Constructor.
40 | 	 *
41 | 	 * @param   string  $name     Name of the table to drop.
42 | 	 * @param   array   $options  Additional settings
43 | 	 */
44 | 	public function __construct(string $name, array $options = [])
45 | 	{
46 | 		$this->tableName = $name;
47 | 		$this->db = isset($options['db']) ? $options['db'] : Factory::getDbo();
48 | 
49 | 		unset($options['db']);
50 | 
51 | 		parent::__construct($options);
52 | 	}
53 | 
54 | 	/**
55 | 	 * Execute the command.
56 | 	 *
57 | 	 * @return  mixed
58 | 	 */
59 | 	public function execute()
60 | 	{
61 | 		try
62 | 		{
63 | 			$result = $this->db->dropTable($this->tableName);
64 | 		}
65 | 		catch (\RuntimeException $e)
66 | 		{
67 | 			throw new \RuntimeException(sprintf('Error dropping DB table `%s`: %s', $this->tableName, $e->getMessage()));
68 | 		}
69 | 	}
70 | }
71 | 


--------------------------------------------------------------------------------
/src/Command/Database/EmptyTable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command\Database;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Command\BaseCommand;
15 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
16 | 
17 | /**
18 |  * Empty a database table.
19 |  *
20 |  * @since  1.8
21 |  */
22 | final class EmptyTable extends BaseCommand implements CommandInterface
23 | {
24 | 	/**
25 | 	 * Database driver.
26 | 	 *
27 | 	 * @var  \JDatabaseDriver
28 | 	 */
29 | 	private $db;
30 | 
31 | 	/**
32 | 	 * Name of the table to empty.
33 | 	 *
34 | 	 * @var  string
35 | 	 */
36 | 	private $tableName;
37 | 
38 | 	/**
39 | 	 * Constructor.
40 | 	 *
41 | 	 * @param   string  $name     Name of the table to empty.
42 | 	 * @param   array   $options  Additional settings
43 | 	 */
44 | 	public function __construct(string $name, array $options = [])
45 | 	{
46 | 		$this->tableName = $name;
47 | 		$this->db = isset($options['db']) ? $options['db'] : Factory::getDbo();
48 | 
49 | 		unset($options['db']);
50 | 
51 | 		parent::__construct($options);
52 | 	}
53 | 
54 | 	/**
55 | 	 * Execute the command.
56 | 	 *
57 | 	 * @return  mixed
58 | 	 */
59 | 	public function execute()
60 | 	{
61 | 		try
62 | 		{
63 | 			$query = $this->db->getQuery(true)
64 | 				->delete($this->db->qn($this->tableName));
65 | 
66 | 			$this->db->setQuery($query);
67 | 			$this->db->execute();
68 | 		}
69 | 		catch (\RuntimeException $e)
70 | 		{
71 | 			throw new \RuntimeException(sprintf('Error emptying DB table `%s`: %s', $this->tableName, $e->getMessage()));
72 | 		}
73 | 	}
74 | }
75 | 


--------------------------------------------------------------------------------
/src/Command/Database/ExecuteSQLFile.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command\Database;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Command\BaseCommand;
15 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
16 | 
17 | /**
18 |  * Executes a SQL file.
19 |  *
20 |  * @since  1.8
21 |  */
22 | final class ExecuteSQLFile extends BaseCommand implements CommandInterface
23 | {
24 | 	/**
25 | 	 * Database driver.
26 | 	 *
27 | 	 * @var  \JDatabaseDriver
28 | 	 */
29 | 	private $db;
30 | 
31 | 	/**
32 | 	 * Path to the file to execute.
33 | 	 *
34 | 	 * @var  string
35 | 	 */
36 | 	private $file;
37 | 
38 | 	/**
39 | 	 * Constructor.
40 | 	 *
41 | 	 * @param   string  $filePath  File to execute.
42 | 	 * @param   array   $options   Additional settings
43 | 	 */
44 | 	public function __construct(string $filePath, array $options = [])
45 | 	{
46 | 		$this->file = $filePath;
47 | 		$this->db = isset($options['db']) ? $options['db'] : Factory::getDbo();
48 | 
49 | 		unset($options['db']);
50 | 
51 | 		parent::__construct($options);
52 | 	}
53 | 
54 | 	/**
55 | 	 * Execute the command.
56 | 	 *
57 | 	 * @return  mixed
58 | 	 */
59 | 	public function execute()
60 | 	{
61 | 		$sql = file_get_contents($this->file);
62 | 
63 | 		foreach ($this->db->splitSql($sql) as $query)
64 | 		{
65 | 			try
66 | 			{
67 | 				$this->db->setQuery($query)->execute();
68 | 			}
69 | 			catch (\Exception $e)
70 | 			{
71 | 				// If the query fails we will go on. It just means the index to be dropped does not exist.
72 | 			}
73 | 		}
74 | 	}
75 | }
76 | 


--------------------------------------------------------------------------------
/src/Command/FileSystem/DeleteFolderRecursively.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Command\FileSystem;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Command\BaseCommand;
14 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
15 | 
16 | /**
17 |  * Delete a folder and all its contents.
18 |  *
19 |  * @since  1.8
20 |  */
21 | class DeleteFolderRecursively extends BaseCommand implements CommandInterface
22 | {
23 | 	/**
24 | 	 * Folder to delete.
25 | 	 *
26 | 	 * @var  string
27 | 	 */
28 | 	private $folder;
29 | 
30 | 	/**
31 | 	 * Constructor.
32 | 	 *
33 | 	 * @param   string  $folder   Folder to delete
34 | 	 * @param   array   $options  Array with other options
35 | 	 */
36 | 	public function __construct(string $folder, array $options = [])
37 | 	{
38 | 		$this->folder = trim($folder);
39 | 
40 | 		parent::__construct($options);
41 | 	}
42 | 
43 | 	/**
44 | 	 * Execute the command.
45 | 	 *
46 | 	 * @return  boolean
47 | 	 */
48 | 	public function execute()
49 | 	{
50 | 		if (!is_dir($this->folder))
51 | 		{
52 | 			return true;
53 | 		}
54 | 
55 | 		$files = glob($this->folder . '/*');
56 | 
57 | 		foreach ($files as $file)
58 | 		{
59 | 			if (is_dir($file))
60 | 			{
61 | 				self::instance([$file])->execute();
62 | 
63 | 				continue;
64 | 			}
65 | 
66 | 			if (!@unlink($file))
67 | 			{
68 | 				$error = sprintf("Error deleting file: `%s`", $file);
69 | 
70 | 				throw new \RuntimeException($error);
71 | 			}
72 | 		}
73 | 
74 | 		if (!rmdir($this->folder))
75 | 		{
76 | 			$error = sprintf("Error deleting folder: `%s`", $this->folder);
77 | 
78 | 			throw new \RuntimeException($error);
79 | 		}
80 | 
81 | 		return true;
82 | 	}
83 | }
84 | 


--------------------------------------------------------------------------------
/src/ComponentEntity.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Table\Table;
14 | use Phproberto\Joomla\Entity\Contracts\ComponentEntityInterface;
15 | use Phproberto\Joomla\Entity\Extensions\Entity\Traits\HasComponent;
16 | 
17 | /**
18 |  * Entity class.
19 |  *
20 |  * @since   1.0.0
21 |  */
22 | abstract class ComponentEntity extends Entity implements ComponentEntityInterface
23 | {
24 | 	use HasComponent;
25 | 
26 | 	/**
27 | 	 * Get a table.
28 | 	 *
29 | 	 * @param   string  $name     Table name. Optional.
30 | 	 * @param   string  $prefix   Class prefix. Optional.
31 | 	 * @param   array   $options  Configuration array for the table. Optional.
32 | 	 *
33 | 	 * @return  Table
34 | 	 *
35 | 	 * @throws  \InvalidArgumentException
36 | 	 *
37 | 	 * @codeCoverageIgnore
38 | 	 */
39 | 	public function table($name = '', $prefix = null, $options = array())
40 | 	{
41 | 		try
42 | 		{
43 | 			Table::addIncludePath($this->component()->tablesFolder());
44 | 		}
45 | 		catch (\Exception $e)
46 | 		{
47 | 			// Avoid folder not found exceptions and hope joomla resolves the table
48 | 		}
49 | 
50 | 		return parent::table($name, $prefix, $options);
51 | 	}
52 | 
53 | 	/**
54 | 	 * Associated table prefix.
55 | 	 *
56 | 	 * @return  string
57 | 	 *
58 | 	 * @since   __DEPLOY_VERSION__
59 | 	 */
60 | 	public function tablePrefix()
61 | 	{
62 | 		return $this->component()->prefix();
63 | 	}
64 | }
65 | 


--------------------------------------------------------------------------------
/src/Content/Article.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Content\Entity\Article as BaseArticle;
14 | 
15 | /**
16 |  * Article entity.
17 |  *
18 |  * @since   1.0.0
19 |  * @deprecated  2.0.0  use Phproberto\Joomla\Entity\Content\Entity\Article;
20 |  */
21 | class Article extends BaseArticle
22 | {
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Content/Category.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Content\Entity\Category as BaseCategory;
14 | 
15 | /**
16 |  * Category entity.
17 |  *
18 |  * @since   1.0.0
19 |  * @deprecated  2.0.0  use Phproberto\Joomla\Entity\Content\Entity\Category;
20 |  */
21 | class Category extends BaseCategory
22 | {
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Content/Command/CreateUncategorisedCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Content\Entity\Category;
15 | use Phproberto\Joomla\Entity\Command\BaseCommand;
16 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
17 | 
18 | /**
19 |  * Create the uncategorised category.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | class CreateUncategorisedCategory extends BaseCommand implements CommandInterface
24 | {
25 | 	/**
26 | 	 * Execute the command.
27 | 	 *
28 | 	 * @return  Category
29 | 	 */
30 | 	public function execute()
31 | 	{
32 | 		return Category::create(
33 | 			[
34 | 				'title'     => 'Uncategorised',
35 | 				'alias'     => 'uncategorised',
36 | 				'parent_id' => Category::root()->id()
37 | 			]
38 | 		);
39 | 	}
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Content/Controller/ArticlesController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Controller;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\MVC\Controller\AdminController;
14 | 
15 | /**
16 |  * Articles Controller.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | abstract class ArticlesController extends AdminController
21 | {
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Content/Search/CategorySearch.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Search;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\Utilities\ArrayHelper;
14 | use Phproberto\Joomla\Entity\Content\Entity\Category;
15 | use Phproberto\Joomla\Entity\Categories\Search\CategorySearch as BaseCategorySearch;
16 | 
17 | /**
18 |  * Category search.
19 |  *
20 |  * @since  1.6.0
21 |  */
22 | class CategorySearch extends BaseCategorySearch
23 | {
24 | 	/**
25 | 	 * Retrieve the search query.
26 | 	 *
27 | 	 * @return  \JDatabaseQuery
28 | 	 */
29 | 	public function searchQuery()
30 | 	{
31 | 		$db = $this->db;
32 | 
33 | 		$query = parent::searchQuery()
34 | 			->where($db->qn('c.extension') . ' = ' . $db->q('com_content'));
35 | 
36 | 		// Filter: tag
37 | 		if (null !== $this->options->get('filter.tag_id'))
38 | 		{
39 | 			$tagIds = ArrayHelper::toInteger((array) $this->options->get('filter.tag_id'));
40 | 
41 | 			$query->leftJoin(
42 | 				$db->quoteName('#__contentitem_tag_map', 'tagmap')
43 | 				. ' ON ' . $db->quoteName('tagmap.content_item_id') . ' = ' . $db->quoteName('c.id')
44 | 				. ' AND ' . $db->quoteName('tagmap.type_alias') . ' = ' . $db->quote(Category::contentTypeAlias())
45 | 			)->where($db->qn('tagmap.tag_id') . ' IN(' . implode(',', $tagIds) . ')');
46 | 		}
47 | 
48 | 		return $query;
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Content/Traits/HasArticle.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Content\Entity\Article;
14 | 
15 | /**
16 |  * Trait for entities that have an associated article.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | trait HasArticle
21 | {
22 | 	/**
23 | 	 * Associated article.
24 | 	 *
25 | 	 * @var  Article
26 | 	 */
27 | 	protected $article;
28 | 
29 | 	/**
30 | 	 * Get the attached database row.
31 | 	 *
32 | 	 * @return  array
33 | 	 */
34 | 	abstract public function all();
35 | 
36 | 	/**
37 | 	 * Get the associated article.
38 | 	 *
39 | 	 * @param   boolean  $reload  Force reloading
40 | 	 *
41 | 	 * @return  Article
42 | 	 */
43 | 	public function getArticle($reload = false)
44 | 	{
45 | 		if ($reload || null === $this->article)
46 | 		{
47 | 			$this->article = $this->loadArticle();
48 | 		}
49 | 
50 | 		return $this->article;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Get the name of the column that stores article.
55 | 	 *
56 | 	 * @return  string
57 | 	 */
58 | 	protected function getColumnArticle()
59 | 	{
60 | 		return 'article_id';
61 | 	}
62 | 
63 | 	/**
64 | 	 * Check if this entity has an associated article.
65 | 	 *
66 | 	 * @return  boolean
67 | 	 */
68 | 	public function hasArticle()
69 | 	{
70 | 		return $this->getArticle()->hasId();
71 | 	}
72 | 
73 | 	/**
74 | 	 * Load the article from the database.
75 | 	 *
76 | 	 * @return  Article
77 | 	 */
78 | 	protected function loadArticle()
79 | 	{
80 | 		$column = $this->getColumnArticle();
81 | 		$data = $this->all();
82 | 
83 | 		if (array_key_exists($column, $data))
84 | 		{
85 | 			return Article::find($data[$column]);
86 | 		}
87 | 
88 | 		return new Article;
89 | 	}
90 | }
91 | 


--------------------------------------------------------------------------------
/src/Content/Traits/HasArticles.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Content\Entity\Article;
14 | 
15 | /**
16 |  * Trait for entities that have associated articles.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | trait HasArticles
21 | {
22 | 	/**
23 | 	 * Associated articles.
24 | 	 *
25 | 	 * @var  Collection
26 | 	 */
27 | 	protected $articles;
28 | 
29 | 	/**
30 | 	 * Clear already loaded articles.
31 | 	 *
32 | 	 * @return  self
33 | 	 */
34 | 	public function clearArticles()
35 | 	{
36 | 		$this->articles = null;
37 | 
38 | 		return $this;
39 | 	}
40 | 
41 | 	/**
42 | 	 * Get the associated articles.
43 | 	 *
44 | 	 * @param   boolean  $reload  Force data reloading
45 | 	 *
46 | 	 * @return  Collection
47 | 	 */
48 | 	public function articles($reload = false)
49 | 	{
50 | 		if ($reload || null === $this->articles)
51 | 		{
52 | 			$this->articles = $this->loadArticles();
53 | 		}
54 | 
55 | 		return $this->articles;
56 | 	}
57 | 
58 | 	/**
59 | 	 * Check if this entity has an associated article.
60 | 	 *
61 | 	 * @param   integer   $id  Article identifier
62 | 	 *
63 | 	 * @return  boolean
64 | 	 */
65 | 	public function hasArticle($id)
66 | 	{
67 | 		return $this->articles()->has($id);
68 | 	}
69 | 
70 | 	/**
71 | 	 * Check if this entity has associated articles.
72 | 	 *
73 | 	 * @return  boolean
74 | 	 */
75 | 	public function hasArticles()
76 | 	{
77 | 		return !$this->articles()->isEmpty();
78 | 	}
79 | 
80 | 	/**
81 | 	 * Load associated articles from DB.
82 | 	 *
83 | 	 * @return  Collection
84 | 	 */
85 | 	abstract protected function loadArticles();
86 | }
87 | 


--------------------------------------------------------------------------------
/src/Content/Validation/ArticleValidator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Content\Validation;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Content\Entity\Article;
14 | use Phproberto\Joomla\Entity\Validation\Validator;
15 | use Phproberto\Joomla\Entity\Validation\Rule;
16 | 
17 | /**
18 |  * ArticleValidator validator.
19 |  *
20 |  * @since  1.0.0
21 |  */
22 | class ArticleValidator extends Validator
23 | {
24 | 	/**
25 | 	 * Constructor.
26 | 	 *
27 | 	 * @param   Article  $article  Article to validate.
28 | 	 */
29 | 	public function __construct(Article $article)
30 | 	{
31 | 		parent::__construct($article);
32 | 
33 | 		$this->addRules(
34 | 			[
35 | 				'title'  => new Rule\IsNotEmptyString('Not empty title'),
36 | 				'catid'  => new Rule\IsPositiveInteger('Valid category identifier'),
37 | 				'access' => new Rule\IsNullOrPositiveInteger('Valid view level identifier')
38 | 			]
39 | 		);
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Contracts/AssociatedEntity.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | 
15 | /**
16 |  * Describes methods required by classes with entity access.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | interface AssociatedEntity
21 | {
22 | 	/**
23 | 	 * Retrieve the associated entity class.
24 | 	 *
25 | 	 * @return  string
26 | 	 */
27 | 	public function entityClass();
28 | 
29 | 	/**
30 | 	 * Retrieve an instance of the associated entity.
31 | 	 *
32 | 	 * @param   integer  $id  Identifier
33 | 	 *
34 | 	 * @return  EntityInterface
35 | 	 */
36 | 	public function entityInstance(int $id = null);
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Contracts/ComponentEntityInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by entities.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | interface ComponentEntityInterface extends EntityInterface
19 | {
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Contracts/ExceptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Exception interface.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | interface ExceptionInterface
19 | {
20 | }
21 | 


--------------------------------------------------------------------------------
/src/Core/Client/Administrator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Client;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Backend client.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | final class Administrator extends BaseClient implements ClientInterface
19 | {
20 | 	/**
21 | 	 * Client identifier.
22 | 	 *
23 | 	 * @const
24 | 	 */
25 | 	const ID = 1;
26 | 
27 | 	/**
28 | 	 * Client name.
29 | 	 *
30 | 	 * @const
31 | 	 */
32 | 	const NAME = 'Administrator';
33 | 
34 | 	/**
35 | 	 * Get the base folder of this client.
36 | 	 *
37 | 	 * @return  string
38 | 	 */
39 | 	public function getFolder()
40 | 	{
41 | 		return JPATH_ADMINISTRATOR;
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Core/Client/BaseClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Client;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Base client.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | abstract class BaseClient
19 | {
20 | 	/**
21 | 	 * Client identifier.
22 | 	 *
23 | 	 * @var  integer
24 | 	 */
25 | 	protected $id;
26 | 
27 | 	/**
28 | 	 * Constructor.
29 | 	 */
30 | 	public function __construct()
31 | 	{
32 | 		$this->id = static::ID;
33 | 	}
34 | 
35 | 	/**
36 | 	 * Get client identifier.
37 | 	 *
38 | 	 * @return  integer
39 | 	 */
40 | 	public function getId()
41 | 	{
42 | 		return $this->id;
43 | 	}
44 | 
45 | 	/**
46 | 	 * Get client name
47 | 	 *
48 | 	 * @return  string
49 | 	 */
50 | 	public function getName()
51 | 	{
52 | 		return static::NAME;
53 | 	}
54 | 
55 | 	/**
56 | 	 * Is this admin client?
57 | 	 *
58 | 	 * @return  boolean
59 | 	 */
60 | 	public function isAdmin()
61 | 	{
62 | 		return $this->id === Administrator::ID;
63 | 	}
64 | 
65 | 	/**
66 | 	 * Is this site client?
67 | 	 *
68 | 	 * @return  boolean
69 | 	 */
70 | 	public function isSite()
71 | 	{
72 | 		return $this->id === Site::ID;
73 | 	}
74 | }
75 | 


--------------------------------------------------------------------------------
/src/Core/Client/Client.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Client;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Client selector.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | abstract class Client
19 | {
20 | 	/**
21 | 	 * Retrieve the active client.
22 | 	 *
23 | 	 * @return  ClientInterface
24 | 	 */
25 | 	public static function active()
26 | 	{
27 | 		return \JFactory::getApplication()->isAdmin() ? self::admin() : self::site();
28 | 	}
29 | 
30 | 	/**
31 | 	 * Retrieve admin client.
32 | 	 *
33 | 	 * @return  Admin
34 | 	 */
35 | 	public static function admin()
36 | 	{
37 | 		return new Administrator;
38 | 	}
39 | 
40 | 	/**
41 | 	 * Retrieve site client.
42 | 	 *
43 | 	 * @return  Site
44 | 	 */
45 | 	public static function site()
46 | 	{
47 | 		return new Site;
48 | 	}
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Core/Client/ClientInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Client;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by modules.
15 |  *
16 |  * @since  0.0.1
17 |  */
18 | interface ClientInterface
19 | {
20 | 	/**
21 | 	 * Get the base folder of this client.
22 | 	 *
23 | 	 * @return  string
24 | 	 */
25 | 	public function getFolder();
26 | 
27 | 	/**
28 | 	 * Get the identifier.
29 | 	 *
30 | 	 * @return  integer
31 | 	 */
32 | 	public function getId();
33 | 
34 | 	/**
35 | 	 * Get the name
36 | 	 *
37 | 	 * @return  string
38 | 	 */
39 | 	public function getName();
40 | 
41 | 	/**
42 | 	 * Is this admin client?
43 | 	 *
44 | 	 * @return  boolean
45 | 	 */
46 | 	public function isAdmin();
47 | 
48 | 	/**
49 | 	 * Is this site client?
50 | 	 *
51 | 	 * @return  boolean
52 | 	 */
53 | 	public function isSite();
54 | }
55 | 


--------------------------------------------------------------------------------
/src/Core/Client/Site.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Client;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Frontend client.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | final class Site extends BaseClient implements ClientInterface
19 | {
20 | 	/**
21 | 	 * Client identifier.
22 | 	 *
23 | 	 * @const
24 | 	 */
25 | 	const ID = 0;
26 | 
27 | 	/**
28 | 	 * Client name.
29 | 	 *
30 | 	 * @const
31 | 	 */
32 | 	const NAME = 'Site';
33 | 
34 | 	/**
35 | 	 * Get the base folder of this client.
36 | 	 *
37 | 	 * @return  string
38 | 	 */
39 | 	public function getFolder()
40 | 	{
41 | 		return JPATH_SITE;
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Core/Command/CreateRootAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Core\Entity\Asset;
15 | use Phproberto\Joomla\Entity\Command\BaseCommand;
16 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
17 | 
18 | /**
19 |  * Create the root asset.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | class CreateRootAsset extends BaseCommand implements CommandInterface
24 | {
25 | 	/**
26 | 	 * Execute the command.
27 | 	 *
28 | 	 * @return  Folder
29 | 	 */
30 | 	public function execute()
31 | 	{
32 | 		$db = Factory::getDbo();
33 | 
34 | 		$data = [
35 | 			'lft'   => 0,
36 | 			'rgt'   => 1,
37 | 			'level' => 0,
38 | 			'name'  => $db->q('root.1'),
39 | 			'title' => $db->q('Root Asset'),
40 | 			'rules' => $db->q(
41 | 				'{'
42 | 				. '"core.login.site":{"6":1,"2":1},"core.login.admin":{"6":1},"core.login.offline":{"6":1},'
43 | 				. '"core.admin":{"8":1},"core.manage":{"7":1},"core.create":{"6":1,"3":1},"core.delete":{"6":1},'
44 | 				. '"core.edit":{"6":1,"4":1},"core.edit.state":{"6":1,"5":1},"core.edit.own":{"6":1,"3":1}'
45 | 				. '}'
46 | 			)
47 | 		];
48 | 
49 | 		$query = $db->getQuery(true)
50 | 			->insert($db->qn('#__assets'))
51 | 			->columns(array_keys($data))
52 | 			->values(implode(',', array_values($data)));
53 | 
54 | 		$db->setQuery($query);
55 | 
56 | 		if (!$db->execute())
57 | 		{
58 | 			throw new \RuntimeException("Error creating root asset: " . $db->stderr(true));
59 | 		}
60 | 
61 | 		return Asset::find($db->insertid());
62 | 	}
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Core/Contracts/Publishable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Publishable entities requirements.
15 |  *
16 |  * @since   1.0.0
17 |  */
18 | interface Publishable
19 | {
20 | 	/**
21 | 	 * Check if this entity is published.
22 | 	 *
23 | 	 * @return  boolean
24 | 	 */
25 | 	public function isPublished();
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Core/Entity/Asset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Entity;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Entity;
14 | 
15 | /**
16 |  * Asset entity.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | class Asset extends Entity
21 | {
22 | 	/**
23 | 	 * Cached root instance.
24 | 	 *
25 | 	 * @var    array
26 | 	 *
27 | 	 * @since  __DEPLOY_VERSION__
28 | 	 */
29 | 	protected static $root;
30 | 
31 | 	/**
32 | 	 * Clear all instances from cache
33 | 	 *
34 | 	 * @return  void
35 | 	 *
36 | 	 * @since   __DEPLOY_VERSION__
37 | 	 */
38 | 	public static function clearAll()
39 | 	{
40 | 		parent::clearAll();
41 | 
42 | 		static::clearRoot();
43 | 	}
44 | 
45 | 	/**
46 | 	 * Clear cached root category.
47 | 	 *
48 | 	 * @return  void
49 | 	 *
50 | 	 * @since   __DEPLOY_VERSION__
51 | 	 */
52 | 	public static function clearRoot()
53 | 	{
54 | 		static::$root = null;
55 | 	}
56 | 
57 | 	/**
58 | 	 * Retrieve root folder.
59 | 	 *
60 | 	 * @return  static
61 | 	 */
62 | 	public static function root()
63 | 	{
64 | 		if (null !== static::$root)
65 | 		{
66 | 			return static::$root;
67 | 		}
68 | 
69 | 		$root = self::loadFromData(['level' => 0]);
70 | 
71 | 		static::$root = $root->isLoaded() ? $root : CreateRootAsset::instance()->execute();
72 | 
73 | 		return static::$root;
74 | 	}
75 | 
76 | 	/**
77 | 	 * Get a table.
78 | 	 *
79 | 	 * @param   string  $name     The table name. Optional.
80 | 	 * @param   string  $prefix   The class prefix. Optional.
81 | 	 * @param   array   $options  Configuration array for model. Optional.
82 | 	 *
83 | 	 * @return  \JTable
84 | 	 *
85 | 	 * @codeCoverageIgnore
86 | 	 */
87 | 	public function table($name = '', $prefix = null, $options = array())
88 | 	{
89 | 		$name = $name ?: 'Asset';
90 | 		$prefix = $prefix ?: 'JTable';
91 | 
92 | 		return parent::table($name, $prefix, $options);
93 | 	}
94 | }
95 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasAncestors.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') or die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
15 | 
16 | /**
17 |  * Trait for entities with ancestors.
18 |  *
19 |  * @since  1.4.0
20 |  */
21 | trait HasAncestors
22 | {
23 | 	/**
24 | 	 * Get a specific ancestor by its id.
25 | 	 *
26 | 	 * @param   integer  $id  Ancestor identifier
27 | 	 *
28 | 	 * @return  static
29 | 	 *
30 | 	 * @throws  \InvalidArgumentException  Ancestor not found
31 | 	 */
32 | 	public function ancestor($id)
33 | 	{
34 | 		return $this->ancestors()->get($id);
35 | 	}
36 | 
37 | 	/**
38 | 	 * Get the Ascendants of an entity.
39 | 	 *
40 | 	 * @return  Collection
41 | 	 */
42 | 	public function ancestors()
43 | 	{
44 | 		return $this->searchAncestors();
45 | 	}
46 | 
47 | 	/**
48 | 	 * Check if this entity has a specific ancestor.
49 | 	 *
50 | 	 * @param   int  $id  Ascendant identifier
51 | 	 *
52 | 	 * @return  boolean
53 | 	 */
54 | 	public function hasAncestor($id)
55 | 	{
56 | 		return $this->ancestors()->has($id);
57 | 	}
58 | 
59 | 	/**
60 | 	 * Check if this entity has ancestors.
61 | 	 *
62 | 	 * @return  boolean
63 | 	 */
64 | 	public function hasAncestors()
65 | 	{
66 | 		return !$this->ancestors()->isEmpty();
67 | 	}
68 | 
69 | 	/**
70 | 	 * Search entity ancestors.
71 | 	 *
72 | 	 * @param   array  $options  Search options. For filters, limit, ordering, etc.
73 | 	 *
74 | 	 * @return  Collection
75 | 	 */
76 | 	abstract public function searchAncestors(array $options = []);
77 | }
78 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\Entity\Asset;
14 | use Phproberto\Joomla\Entity\Core\CoreColumn;
15 | 
16 | /**
17 |  * Trait for entities that have an asset. Based on asset_id column.
18 |  *
19 |  * @since  1.0.0
20 |  */
21 | trait HasAsset
22 | {
23 | 	/**
24 | 	 * Associated asset.
25 | 	 *
26 | 	 * @var  Asset
27 | 	 */
28 | 	protected $asset;
29 | 
30 | 	/**
31 | 	 * Get the alias for a specific DB column.
32 | 	 *
33 | 	 * @param   string  $column  Name of the DB column. Example: created_by
34 | 	 *
35 | 	 * @return  string
36 | 	 */
37 | 	abstract public function columnAlias($column);
38 | 
39 | 	/**
40 | 	 * Get a property of this entity.
41 | 	 *
42 | 	 * @param   string  $property  Name of the property to get
43 | 	 * @param   mixed   $default   Value to use as default if property is not set or is null
44 | 	 *
45 | 	 * @return  mixed
46 | 	 */
47 | 	abstract public function get($property, $default = null);
48 | 
49 | 	/**
50 | 	 * Get the associated asset.
51 | 	 *
52 | 	 * @param   boolean  $reload  Force asset reloading
53 | 	 *
54 | 	 * @return  Asset
55 | 	 */
56 | 	public function asset($reload = false)
57 | 	{
58 | 		if ($reload || null === $this->asset)
59 | 		{
60 | 			$this->asset = $this->loadAsset();
61 | 		}
62 | 
63 | 		return $this->asset;
64 | 	}
65 | 
66 | 	/**
67 | 	 * Load the asset from the database.
68 | 	 *
69 | 	 * @return  Asset
70 | 	 */
71 | 	protected function loadAsset()
72 | 	{
73 | 		try
74 | 		{
75 | 			$assetId = (int) $this->get($this->columnAlias(CoreColumn::ASSET));
76 | 		}
77 | 		catch (\Exception $e)
78 | 		{
79 | 			$assetId = 0;
80 | 		}
81 | 
82 | 		return $assetId ? Asset::find($assetId) : new Asset;
83 | 	}
84 | }
85 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasChildren.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') or die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
15 | 
16 | /**
17 |  * Trait for entities with child entities.
18 |  *
19 |  * @since  1.4.0
20 |  */
21 | trait HasChildren
22 | {
23 | 	/**
24 | 	 * Get a specific child by its id.
25 | 	 *
26 | 	 * @param   int  $id  Ascendant identifier
27 | 	 *
28 | 	 * @return  mixed  null || static
29 | 	 *
30 | 	 * @throws  \InvalidArgumentException  Descendant not found
31 | 	 */
32 | 	public function child($id)
33 | 	{
34 | 		return $this->children()->get($id);
35 | 	}
36 | 
37 | 	/**
38 | 	 * Get the children of this entity.
39 | 	 *
40 | 	 * @return  Collection
41 | 	 */
42 | 	public function children()
43 | 	{
44 | 		return $this->searchChildren();
45 | 	}
46 | 
47 | 	/**
48 | 	 * Check if this entity has an specific child.
49 | 	 *
50 | 	 * @param   int  $id  Ascendant identifier
51 | 	 *
52 | 	 * @return  boolean
53 | 	 */
54 | 	public function hasChild($id)
55 | 	{
56 | 		return $this->children()->has($id);
57 | 	}
58 | 
59 | 	/**
60 | 	 * Check if this entity has children.
61 | 	 *
62 | 	 * @return  boolean
63 | 	 */
64 | 	public function hasChildren()
65 | 	{
66 | 		return !$this->children()->isEmpty();
67 | 	}
68 | 
69 | 	/**
70 | 	 * Search entity children.
71 | 	 *
72 | 	 * @param   array  $options  Search options. For filters, limit, ordering, etc.
73 | 	 *
74 | 	 * @return  Collection
75 | 	 */
76 | 	abstract public function searchChildren(array $options = []);
77 | }
78 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\Client\Administrator;
14 | use Phproberto\Joomla\Entity\Core\Client\Client;
15 | use Phproberto\Joomla\Entity\Core\Client\ClientInterface;
16 | use Phproberto\Joomla\Entity\Core\Client\Site;
17 | use Phproberto\Joomla\Entity\Core\CoreColumn;
18 | 
19 | /**
20 |  * Trait for entities that have an associated client.
21 |  *
22 |  * @since  1.0.0
23 |  */
24 | trait HasClient
25 | {
26 | 	/**
27 | 	 * Associated client.
28 | 	 *
29 | 	 * @var  ClientInterface
30 | 	 */
31 | 	protected $client;
32 | 
33 | 	/**
34 | 	 * Switch to admin client.
35 | 	 *
36 | 	 * @return  self
37 | 	 */
38 | 	public function admin()
39 | 	{
40 | 		$this->client = new Administrator;
41 | 
42 | 		return $this;
43 | 	}
44 | 
45 | 	/**
46 | 	 * Get the associated client.
47 | 	 *
48 | 	 * @param   boolean  $reload  Force reloading
49 | 	 *
50 | 	 * @return  ClientInterface
51 | 	 */
52 | 	public function client($reload = false)
53 | 	{
54 | 		if ($reload || null === $this->client)
55 | 		{
56 | 			$this->client = $this->loadClient();
57 | 		}
58 | 
59 | 		return $this->client;
60 | 	}
61 | 
62 | 	/**
63 | 	 * Load the client from the database.
64 | 	 *
65 | 	 * @return  Category
66 | 	 */
67 | 	protected function loadClient()
68 | 	{
69 | 		$clientId = (int) $this->get($this->columnAlias(CoreColumn::CLIENT));
70 | 
71 | 		return $clientId ? Client::admin() : Client::site();
72 | 	}
73 | 
74 | 	/**
75 | 	 * Switch to site client.
76 | 	 *
77 | 	 * @return  self
78 | 	 */
79 | 	public function site()
80 | 	{
81 | 		$this->client = new Site;
82 | 
83 | 		return $this;
84 | 	}
85 | }
86 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasDescendants.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') or die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
15 | 
16 | /**
17 |  * Trait for entities with descendants.
18 |  *
19 |  * @since  1.4.0
20 |  */
21 | trait HasDescendants
22 | {
23 | 	/**
24 | 	 * Get a specific descendant by its id.
25 | 	 *
26 | 	 * @param   int  $id  Ascendant identifier
27 | 	 *
28 | 	 * @return  mixed  null || static
29 | 	 *
30 | 	 * @throws  \InvalidArgumentException  Descendant not found
31 | 	 */
32 | 	public function descendant($id)
33 | 	{
34 | 		return $this->descendants()->get($id);
35 | 	}
36 | 
37 | 	/**
38 | 	 * Get the descendants of this entity.
39 | 	 *
40 | 	 * @return  Collection
41 | 	 */
42 | 	public function descendants()
43 | 	{
44 | 		return $this->searchDescendants();
45 | 	}
46 | 
47 | 	/**
48 | 	 * Check if this entity has an specific descendant.
49 | 	 *
50 | 	 * @param   int  $id  Ascendant identifier
51 | 	 *
52 | 	 * @return  boolean
53 | 	 */
54 | 	public function hasDescendant($id)
55 | 	{
56 | 		return $this->descendants()->has($id);
57 | 	}
58 | 
59 | 	/**
60 | 	 * Check if this entity has descendants.
61 | 	 *
62 | 	 * @return  boolean
63 | 	 */
64 | 	public function hasDescendants()
65 | 	{
66 | 		return !$this->descendants()->isEmpty();
67 | 	}
68 | 
69 | 	/**
70 | 	 * Search entity descendants.
71 | 	 *
72 | 	 * @param   array  $options  Search options. For filters, limit, ordering, etc.
73 | 	 *
74 | 	 * @return  Collection
75 | 	 */
76 | 	abstract public function searchDescendants(array $options = []);
77 | }
78 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasFeatured.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\CoreColumn;
14 | 
15 | /**
16 |  * Trait for entities with featured column.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | trait HasFeatured
21 | {
22 | 	/**
23 | 	 * Is this entity featured.
24 | 	 *
25 | 	 * @var  boolean
26 | 	 */
27 | 	protected $featured;
28 | 
29 | 	/**
30 | 	 * Get the alias for a specific DB column.
31 | 	 *
32 | 	 * @param   string  $column  Name of the DB column. Example: created_by
33 | 	 *
34 | 	 * @return  string
35 | 	 */
36 | 	abstract public function columnAlias($column);
37 | 
38 | 	/**
39 | 	 * Get a property of this entity.
40 | 	 *
41 | 	 * @param   string  $property  Name of the property to get
42 | 	 * @param   mixed   $default   Value to use as default if property is not set or is null
43 | 	 *
44 | 	 * @return  mixed
45 | 	 */
46 | 	abstract public function get($property, $default = null);
47 | 
48 | 	/**
49 | 	 * Is this article featured?
50 | 	 *
51 | 	 * @return  boolean
52 | 	 */
53 | 	public function isFeatured()
54 | 	{
55 | 		$featured = (int) $this->get($this->columnAlias(CoreColumn::FEATURED));
56 | 
57 | 		return $featured ? true : false;
58 | 	}
59 | }
60 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasInstances.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Classes using multiple singleton instances.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | trait HasInstances
19 | {
20 | 	/**
21 | 	 * Cached instances
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected static $instances = array();
26 | 
27 | 	/**
28 | 	 * Remove an instance from cache.
29 | 	 *
30 | 	 * @param   integer  $id  Class identifier
31 | 	 *
32 | 	 * @return  void
33 | 	 */
34 | 	public static function clear($id)
35 | 	{
36 | 		unset(static::$instances[get_called_class()][$id]);
37 | 	}
38 | 
39 | 	/**
40 | 	 * Clear all instances from cache
41 | 	 *
42 | 	 * @return  void
43 | 	 */
44 | 	public static function clearAll()
45 | 	{
46 | 		unset(static::$instances[get_called_class()]);
47 | 	}
48 | 
49 | 	/**
50 | 	 * Ensure that we retrieve a non-statically-cached instance.
51 | 	 *
52 | 	 * @param   integer  $id   Identifier of the instance
53 | 	 *
54 | 	 * @return  $this
55 | 	 */
56 | 	public static function fresh($id)
57 | 	{
58 | 		static::clear($id);
59 | 
60 | 		return static::find($id);
61 | 	}
62 | 
63 | 	/**
64 | 	 * Create and return a cached instance
65 | 	 *
66 | 	 * @param   integer  $id  Identifier of the instance
67 | 	 *
68 | 	 * @return  $this
69 | 	 */
70 | 	public static function find($id)
71 | 	{
72 | 		$class = get_called_class();
73 | 
74 | 		if (empty(static::$instances[$class][$id]))
75 | 		{
76 | 			static::$instances[$class][$id] = new static($id);
77 | 		}
78 | 
79 | 		return static::$instances[$class][$id];
80 | 	}
81 | }
82 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasLink.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Trait for linkable entities.
15 |  *
16 |  * @since   1.0.0
17 |  */
18 | trait HasLink
19 | {
20 | 	/**
21 | 	 * Link to this entity.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $link;
26 | 
27 | 	/**
28 | 	 * Gets the Identifier.
29 | 	 *
30 | 	 * @return  integer
31 | 	 */
32 | 	abstract public function id();
33 | 
34 | 	/**
35 | 	 * Get the link to this entity.
36 | 	 *
37 | 	 * @param   boolean  $reload  Force reloading
38 | 	 *
39 | 	 * @return  string
40 | 	 */
41 | 	public function link($reload = false)
42 | 	{
43 | 		if ($reload || null === $this->link)
44 | 		{
45 | 			$this->link = $this->loadLink();
46 | 		}
47 | 
48 | 		return $this->link;
49 | 	}
50 | 
51 | 	/**
52 | 	 * Get the URL slug.
53 | 	 *
54 | 	 * @return  string
55 | 	 */
56 | 	public function slug()
57 | 	{
58 | 		$slug = $this->id();
59 | 
60 | 		if (!$slug)
61 | 		{
62 | 			return null;
63 | 		}
64 | 
65 | 		if ($this->has('alias'))
66 | 		{
67 | 			$slug .= ':' . $this->get('alias');
68 | 		}
69 | 
70 | 		return $slug;
71 | 	}
72 | 
73 | 	/**
74 | 	 * Load the link to this entity.
75 | 	 *
76 | 	 * @return  string
77 | 	 */
78 | 	abstract protected function loadLink();
79 | }
80 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasMetadata.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\CoreColumn;
14 | 
15 | /**
16 |  * Trait for entities with metadata. Based on metadata columns.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | trait HasMetadata
21 | {
22 | 	/**
23 | 	 * Metadata
24 | 	 *
25 | 	 * @var  array
26 | 	 */
27 | 	protected $metadata;
28 | 
29 | 	/**
30 | 	 * Get the alias for a specific DB column.
31 | 	 *
32 | 	 * @param   string  $column  Name of the DB column. Example: created_by
33 | 	 *
34 | 	 * @return  string
35 | 	 */
36 | 	abstract public function columnAlias($column);
37 | 
38 | 	/**
39 | 	 * Get the content of a column with data stored in JSON.
40 | 	 *
41 | 	 * @param   string  $property  Name of the column storing data
42 | 	 *
43 | 	 * @return  array
44 | 	 */
45 | 	abstract public function json($property);
46 | 
47 | 	/**
48 | 	 * Get article metadata.
49 | 	 *
50 | 	 * @param   boolean  $reload  Force reloading
51 | 	 *
52 | 	 * @return  array
53 | 	 */
54 | 	public function metadata($reload = false)
55 | 	{
56 | 		if ($reload || null === $this->metadata)
57 | 		{
58 | 			$this->metadata = $this->json($this->columnAlias(CoreColumn::METADATA));
59 | 		}
60 | 
61 | 		return $this->metadata;
62 | 	}
63 | }
64 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasParent.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Joomla! entity library.
  4 |  *
  5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
  6 |  * @license    See COPYING.txt
  7 |  */
  8 | 
  9 | namespace Phproberto\Joomla\Entity\Core\Traits;
 10 | 
 11 | defined('_JEXEC') or die;
 12 | 
 13 | use Phproberto\Joomla\Entity\Core\CoreColumn;
 14 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
 15 | 
 16 | /**
 17 |  * Trait for entities with a parent entity.
 18 |  *
 19 |  * @since  1.4.0
 20 |  */
 21 | trait HasParent
 22 | {
 23 | 	/**
 24 | 	 * Entitiy parent.
 25 | 	 *
 26 | 	 * @var  EntityInterface
 27 | 	 */
 28 | 	protected $parent;
 29 | 
 30 | 	/**
 31 | 	 * Check if this entity has an assigned parent.
 32 | 	 *
 33 | 	 * @return  boolean
 34 | 	 *
 35 | 	 * @since   1.8
 36 | 	 */
 37 | 	public function hasParent()
 38 | 	{
 39 | 		return $this->parentId() > 0;
 40 | 	}
 41 | 
 42 | 	/**
 43 | 	 * Load the parent entity.
 44 | 	 *
 45 | 	 * @return  EntityInterface
 46 | 	 */
 47 | 	protected function loadParent()
 48 | 	{
 49 | 		$column = $this->parentColumn();
 50 | 		$data = $this->all();
 51 | 
 52 | 		if (empty($data[$column]))
 53 | 		{
 54 | 			return new static;
 55 | 		}
 56 | 
 57 | 		return static::find($data[$column]);
 58 | 	}
 59 | 
 60 | 	/**
 61 | 	 * Retrieve the parent entity.
 62 | 	 *
 63 | 	 * @return  EntityInterface
 64 | 	 */
 65 | 	public function parent()
 66 | 	{
 67 | 		if (null === $this->parent)
 68 | 		{
 69 | 			$this->parent = $this->loadParent();
 70 | 		}
 71 | 
 72 | 		return $this->parent;
 73 | 	}
 74 | 
 75 | 	/**
 76 | 	 * Retrieve parent identifier.
 77 | 	 *
 78 | 	 * @return  integer
 79 | 	 */
 80 | 	public function parentId()
 81 | 	{
 82 | 		$column = $this->parentColumn();
 83 | 
 84 | 		if (!$this->has($column))
 85 | 		{
 86 | 			return 0;
 87 | 		}
 88 | 
 89 | 		return (int) $this->get($column);
 90 | 	}
 91 | 
 92 | 	/**
 93 | 	 * Column used to store the parent identifier.
 94 | 	 *
 95 | 	 * @return  string
 96 | 	 */
 97 | 	public function parentColumn()
 98 | 	{
 99 | 		return $this->columnAlias(CoreColumn::PARENT);
100 | 	}
101 | }
102 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasPublishDown.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\CoreColumn;
14 | 
15 | /**
16 |  * Trait for entities that have an associated publish down column.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | trait HasPublishDown
21 | {
22 | 	/**
23 | 	 * Get the empty date for the active DB driver.
24 | 	 *
25 | 	 * @return  string
26 | 	 *
27 | 	 * @codeCoverageIgnore
28 | 	 */
29 | 	abstract protected function nullDate();
30 | 
31 | 	/**
32 | 	 * Get the publish down date.
33 | 	 *
34 | 	 * @return  string
35 | 	 */
36 | 	public function getPublishDown()
37 | 	{
38 | 		return $this->get($this->columnAlias(CoreColumn::PUBLISH_DOWN));
39 | 	}
40 | 
41 | 	/**
42 | 	 * Has this entity a publish down date?
43 | 	 *
44 | 	 * @return  boolean
45 | 	 */
46 | 	public function hasPublishDown()
47 | 	{
48 | 		$publishDown = $this->getPublishDown();
49 | 
50 | 		return !empty($publishDown) && $publishDown !== $this->nullDate();
51 | 	}
52 | 
53 | 	/**
54 | 	 * Check if this entity is published down.
55 | 	 *
56 | 	 * @return  boolean
57 | 	 */
58 | 	public function isPublishedDown()
59 | 	{
60 | 		if (!$this->hasPublishDown())
61 | 		{
62 | 			return false;
63 | 		}
64 | 
65 | 		return \JFactory::getDate($this->getPublishDown()) <= \JFactory::getDate();
66 | 	}
67 | }
68 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasPublishUp.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Core\CoreColumn;
14 | 
15 | /**
16 |  * Trait for entities that have an associated publish up column.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | trait HasPublishUp
21 | {
22 | 	/**
23 | 	 * Get the empty date for the active DB driver.
24 | 	 *
25 | 	 * @return  string
26 | 	 *
27 | 	 * @codeCoverageIgnore
28 | 	 */
29 | 	abstract protected function nullDate();
30 | 
31 | 	/**
32 | 	 * Get the publish up date.
33 | 	 *
34 | 	 * @return  string
35 | 	 */
36 | 	public function getPublishUp()
37 | 	{
38 | 		return $this->get($this->columnAlias(CoreColumn::PUBLISH_UP));
39 | 	}
40 | 
41 | 	/**
42 | 	 * Has this entity a publish up date?
43 | 	 *
44 | 	 * @return  boolean
45 | 	 */
46 | 	public function hasPublishUp()
47 | 	{
48 | 		$publishUp = $this->getPublishUp();
49 | 
50 | 		return !empty($publishUp) && $publishUp !== $this->nullDate();
51 | 	}
52 | 
53 | 	/**
54 | 	 * Check if this entity is published up.
55 | 	 *
56 | 	 * @return  boolean
57 | 	 */
58 | 	public function isPublishedUp()
59 | 	{
60 | 		if (!$this->hasPublishUp())
61 | 		{
62 | 			return true;
63 | 		}
64 | 
65 | 		return \JFactory::getDate($this->getPublishUp()) <= \JFactory::getDate();
66 | 	}
67 | }
68 | 


--------------------------------------------------------------------------------
/src/Core/Traits/HasSingleton.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Core\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Classes that provide singleton access.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasSingleton
19 | {
20 | 	/**
21 | 	 * The instance.
22 | 	 *
23 | 	 * @var  $this
24 | 	 */
25 | 	protected static $instance;
26 | 
27 | 	/**
28 | 	 * Clear singleton instance.
29 | 	 *
30 | 	 * @return  void
31 | 	 */
32 | 	public static function clearInstance()
33 | 	{
34 | 		static::$instance = null;
35 | 	}
36 | 
37 | 	/**
38 | 	 * Gets an instance or create it.
39 | 	 *
40 | 	 * @return  static
41 | 	 */
42 | 	public static function instance()
43 | 	{
44 | 		if (null === static::$instance)
45 | 		{
46 | 			static::$instance = new static;
47 | 		}
48 | 
49 | 		return static::$instance;
50 | 	}
51 | }
52 | 


--------------------------------------------------------------------------------
/src/Decorator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | 
15 | /**
16 |  * Represents a collection of entities.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | abstract class Decorator
21 | {
22 | 	/**
23 | 	 * Decorated entity.
24 | 	 *
25 | 	 * @var  EntityInterface
26 | 	 */
27 | 	protected $entity;
28 | 
29 | 	/**
30 | 	 * Constructor.
31 | 	 *
32 | 	 * @param   EntityInterface  $entity  Entity to decorate.
33 | 	 */
34 | 	public function __construct(EntityInterface $entity)
35 | 	{
36 | 		$this->entity = $entity;
37 | 	}
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Exception/DeleteException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Exception;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
15 | 
16 | /**
17 |  * Errors deleting an entity.
18 |  *
19 |  * @since  1.2.0
20 |  */
21 | class DeleteException extends \RuntimeException implements ExceptionInterface
22 | {
23 | 	/**
24 | 	 * Entity cannot be saved.
25 | 	 *
26 | 	 * @param   EntityInterface  $entity  Entity with empty data
27 | 	 * @param   \JTable          $table   Table containing the entity data
28 | 	 *
29 | 	 * @return  static
30 | 	 */
31 | 	public static function fromTable(EntityInterface $entity, \JTable $table)
32 | 	{
33 | 		$msg = sprintf("Delete failed trying to delete `%s`:</br> %s", $entity->name() . '::' . $entity->id(), $table->getError());
34 | 
35 | 		return new static($msg, 500);
36 | 	}
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Exception/InvalidEntityData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Exception;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
15 | 
16 | /**
17 |  * Invalid entity data errors.
18 |  *
19 |  * @since  1.0.0
20 |  */
21 | class InvalidEntityData extends \RuntimeException implements ExceptionInterface
22 | {
23 | 	/**
24 | 	 * Data is empty.
25 | 	 *
26 | 	 * @param   EntityInterface  $entity  Entity with empty data
27 | 	 *
28 | 	 * @return  static
29 | 	 */
30 | 	public static function emptyData(EntityInterface $entity)
31 | 	{
32 | 		return new static('Data for entity ' . get_class($entity) . ' (id: `' . $entity->id() . '`) is empty.', 500);
33 | 	}
34 | 
35 | 	/**
36 | 	 * Data is empty.
37 | 	 *
38 | 	 * @param   EntityInterface  $entity  Entity with empty data
39 | 	 *
40 | 	 * @return  static
41 | 	 */
42 | 	public static function missingPrimaryKey(EntityInterface $entity)
43 | 	{
44 | 		return new static(
45 | 			'Data for entity ' . get_class($entity) . ' (id: `' . $entity->id() . '`)'
46 | 			. ' does not contain primary key (column: ' . $entity->primaryKey() . ')',
47 | 			500
48 | 		);
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Exception/LoadEntityDataError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Exception;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
15 | 
16 | /**
17 |  * Invalid entity data errors.
18 |  *
19 |  * @since  1.0.0
20 |  */
21 | class LoadEntityDataError extends \RuntimeException implements ExceptionInterface
22 | {
23 | 	/**
24 | 	 * Data is empty.
25 | 	 *
26 | 	 * @param   EntityInterface  $entity  Entity with empty data
27 | 	 * @param   string           $error   Error returned by the dable
28 | 	 *
29 | 	 * @return  static
30 | 	 */
31 | 	public static function tableError(EntityInterface $entity, $error)
32 | 	{
33 | 		return new static('Table returned an error loading ' . get_class($entity) . ' (id: `' . $entity->id() . '`) data: ' . $error, 500);
34 | 	}
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Exception/SaveException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Exception;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
15 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
16 | 
17 | /**
18 |  * Errors saving entity.
19 |  *
20 |  * @since  1.0.0
21 |  */
22 | class SaveException extends \RuntimeException implements ExceptionInterface
23 | {
24 | 	/**
25 | 	 * Entity cannot be saved.
26 | 	 *
27 | 	 * @param   EntityInterface  $entity  Entity with empty data
28 | 	 * @param   \JTable          $table   Table containing the entity data
29 | 	 *
30 | 	 * @return  static
31 | 	 */
32 | 	public static function table(EntityInterface $entity, \JTable $table)
33 | 	{
34 | 		if (!$entity->hasId())
35 | 		{
36 | 			$msg = sprintf("Save failed trying to create `%s`:</br> %s", $entity->name(), $table->getError());
37 | 
38 | 			return new static($msg, 500);
39 | 		}
40 | 
41 | 		$msg = sprintf("Save failed trying to save `%s`:</br> %s", $entity->name() . '::' . $entity->id(), $table->getError());
42 | 
43 | 		return new static($msg, 500);
44 | 	}
45 | 
46 | 	/**
47 | 	 * Entity did not pass validation.
48 | 	 *
49 | 	 * @param   EntityInterface      $entity     Entity with empty data
50 | 	 * @param   ValidationException  $exception  Validation exception
51 | 	 *
52 | 	 * @return  static
53 | 	 */
54 | 	public static function validation(EntityInterface $entity, ValidationException $exception)
55 | 	{
56 | 		if (!$entity->hasId())
57 | 		{
58 | 			$msg = sprintf("Validation failed trying to create `%s`:</br> %s", $entity->name(), $exception->getMessage());
59 | 
60 | 			return new static($msg, 500);
61 | 		}
62 | 
63 | 		$msg = sprintf("Validation failed trying to save `%s`:</br> %s", $entity->name() . '::' . $entity->id(), $exception->getMessage());
64 | 
65 | 		return new static($msg, 500);
66 | 	}
67 | }
68 | 


--------------------------------------------------------------------------------
/src/Extensions/Entity/ActiveComponent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Extensions\Entity;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Exception\InvalidEntityData;
14 | use Phproberto\Joomla\Entity\Exception\LoadEntityDataError;
15 | 
16 | /**
17 |  * Component entity.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class ActiveComponent extends Component
22 | {
23 | 	/**
24 | 	 * Load the entity from the database.
25 | 	 *
26 | 	 * @return  array
27 | 	 *
28 | 	 * @throws  LoadEntityDataError  Table error loading row
29 | 	 * @throws  InvalidEntityData    Incorrect data received
30 | 	 */
31 | 	protected function fetchRow()
32 | 	{
33 | 		$option = $this->option();
34 | 
35 | 		if (!$option)
36 | 		{
37 | 			throw new \RuntimeException('Unable to detect active component option');
38 | 		}
39 | 
40 | 		$table = $this->table();
41 | 
42 | 		if (!$table->load(array('element' => $option, 'type' => 'component')))
43 | 		{
44 | 			throw LoadEntityDataError::tableError($this, $table->getError());
45 | 		}
46 | 
47 | 		$data = $table->getProperties(true);
48 | 
49 | 		if (!array_key_exists($this->primaryKey(), $data))
50 | 		{
51 | 			throw InvalidEntityData::missingPrimaryKey($this);
52 | 		}
53 | 
54 | 		$this->id = (int) $data[$this->primaryKey()];
55 | 
56 | 		return $data;
57 | 	}
58 | 
59 | 	/**
60 | 	 * Get the active option.
61 | 	 *
62 | 	 * @return  string
63 | 	 */
64 | 	public function option()
65 | 	{
66 | 		return \JApplicationHelper::getComponentName();
67 | 	}
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Extensions/Entity/Traits/HasComponent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Extensions\Entity\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Extensions\Entity\Component;
14 | 
15 | /**
16 |  * Trait for entities with an associated component.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | trait HasComponent
21 | {
22 | 	/**
23 | 	 * Entity component
24 | 	 *
25 | 	 * @var  Component
26 | 	 */
27 | 	protected $component;
28 | 
29 | 	/**
30 | 	 * Component option.
31 | 	 *
32 | 	 * @var string
33 | 	 */
34 | 	protected $componentOption;
35 | 
36 | 	/**
37 | 	 * Retrieve the associated component.
38 | 	 *
39 | 	 * @return  Component
40 | 	 */
41 | 	public function component()
42 | 	{
43 | 		if (null === $this->component)
44 | 		{
45 | 			$this->component = $this->loadComponent();
46 | 		}
47 | 
48 | 		return $this->component;
49 | 	}
50 | 
51 | 	/**
52 | 	 * Try to guess component option from class prefix
53 | 	 *
54 | 	 * @return  mixed  null (not found) | string (found)
55 | 	 */
56 | 	protected function componentOption()
57 | 	{
58 | 		if (null === $this->componentOption)
59 | 		{
60 | 			$this->componentOption = $this->componentOptionFromClass();
61 | 		}
62 | 
63 | 		return $this->componentOption;
64 | 	}
65 | 
66 | 	/**
67 | 	 * Try to guess component option from class.
68 | 	 *
69 | 	 * @return  string
70 | 	 */
71 | 	protected function componentOptionFromClass()
72 | 	{
73 | 		$class = get_class($this);
74 | 
75 | 		if (false !== strpos($class, '\\'))
76 | 		{
77 | 			$suffix = rtrim(strstr($class, 'Entity'), '\\');
78 | 			$parts = explode("\\", $suffix);
79 | 
80 | 			return array_key_exists(1, $parts) ? 'com_' . strtolower($parts[1]) : null;
81 | 		}
82 | 
83 | 		return  'com_' . strtolower(strstr($class, 'Entity', true));
84 | 	}
85 | 
86 | 	/**
87 | 	 * Load associated component
88 | 	 *
89 | 	 * @return  Component
90 | 	 *
91 | 	 * @throws  \InvalidArgumentException  Wrong option received
92 | 	 * @throws  \RuntimeException          Component not found
93 | 	 */
94 | 	protected function loadComponent()
95 | 	{
96 | 		return Component::fromOption($this->componentOption());
97 | 	}
98 | }
99 | 


--------------------------------------------------------------------------------
/src/Fields/Column.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Fields;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Columns supported by fields.
15 |  *
16 |  * @since   1.2.0
17 |  */
18 | abstract class Column
19 | {
20 | 	/**
21 | 	 * Default column used to store field group.
22 | 	 *
23 | 	 * @const
24 | 	 */
25 | 	const FIELD_GROUP = 'group_id';
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Fields/FieldGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Fields;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\Fields\Column;
15 | use Phproberto\Joomla\Entity\ComponentEntity;
16 | use Phproberto\Joomla\Entity\Fields\Traits\HasFields;
17 | use Phproberto\Joomla\Entity\Core\Traits as CoreTraits;
18 | use Phproberto\Joomla\Entity\Core\Contracts\Publishable;
19 | 
20 | /**
21 |  * Field Group entity.
22 |  *
23 |  * @since   1.2.0
24 |  */
25 | class FieldGroup extends ComponentEntity implements Publishable
26 | {
27 | 	use CoreTraits\HasParams, CoreTraits\HasState, HasFields;
28 | 
29 | 	/**
30 | 	 * Load associated fields from DB.
31 | 	 *
32 | 	 * @return  Collection
33 | 	 */
34 | 	protected function loadFields()
35 | 	{
36 | 		$fields = new Collection;
37 | 
38 | 		if (!$this->hasId())
39 | 		{
40 | 			return $fields;
41 | 		}
42 | 
43 | 		$db = $this->getDbo();
44 | 		$query = $db->getQuery(true)
45 | 			->select('f.*')
46 | 			->from($db->qn('#__fields', 'f'))
47 | 			->where($db->qn('f.group_id') . ' = ' . (int) $this->id());
48 | 
49 | 		$db->setQuery($query);
50 | 
51 | 		$items = $db->loadObjectList() ?: [];
52 | 
53 | 		foreach ($items as $item)
54 | 		{
55 | 			$field = Field::find($item->id)->bind($item);
56 | 
57 | 			$fields->add($field);
58 | 		}
59 | 
60 | 		return $fields;
61 | 	}
62 | 
63 | 	/**
64 | 	 * Get a table instance. Defauts to \JTableUser.
65 | 	 *
66 | 	 * @param   string  $name     Table name. Optional.
67 | 	 * @param   string  $prefix   Class prefix. Optional.
68 | 	 * @param   array   $options  Configuration array for the table. Optional.
69 | 	 *
70 | 	 * @return  \JTable
71 | 	 *
72 | 	 * @throws  \InvalidArgumentException
73 | 	 */
74 | 	public function table($name = '', $prefix = null, $options = array())
75 | 	{
76 | 		$name = $name ?: 'Group';
77 | 		$prefix = $prefix ?: 'FieldsTable';
78 | 
79 | 		if ($prefix === 'FieldsTable')
80 | 		{
81 | 			return $this->component()->table($name);
82 | 		}
83 | 
84 | 		return parent::table($name, $prefix, $options);
85 | 	}
86 | }
87 | 


--------------------------------------------------------------------------------
/src/Helper/ArrayHelper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Helper;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Utility class for common stuff with arrays.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | abstract class ArrayHelper
19 | {
20 | 	/**
21 | 	 * Function to convert array to valid db identifiers values
22 | 	 *
23 | 	 * @param   array  $array  Array or single value to convert
24 | 	 *
25 | 	 * @return  array
26 | 	 */
27 | 	public static function toPositiveIntegers(array $array): array
28 | 	{
29 | 		return array_values(
30 | 			array_unique(
31 | 				array_filter(
32 | 					array_map('intval', $array),
33 | 					function ($value)
34 | 					{
35 | 						return (int) $value > 0;
36 | 					}
37 | 				)
38 | 			)
39 | 		);
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Helper/ClassName.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Helper;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
14 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
15 | 
16 | /**
17 |  * Helper to deal with class name/namespaces things.
18 |  *
19 |  * @since  __DEPLOY_VERSION__
20 |  */
21 | abstract class ClassName
22 | {
23 | 	/**
24 | 	 * Check if a class uses namespace.
25 | 	 *
26 | 	 * @param   object  $class  Class instance
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public static function inNamespace($class): bool
31 | 	{
32 | 		return (new \ReflectionClass($class))->inNamespace();
33 | 	}
34 | 
35 | 	/**
36 | 	 * Retrieve class namespace.
37 | 	 *
38 | 	 * @param   object  $class  Class instance
39 | 	 *
40 | 	 * @return  string
41 | 	 */
42 | 	public static function namespace($class): string
43 | 	{
44 | 		return (new \ReflectionClass($class))->getNamespaceName();
45 | 	}
46 | 
47 | 	/**
48 | 	 * Get the namespace parts.
49 | 	 *
50 | 	 * @param   object  $class  Class instance
51 | 	 *
52 | 	 * @return  string[]
53 | 	 */
54 | 	public static function namespaceParts($class): array
55 | 	{
56 | 		return explode('\\', self::namespace($class));
57 | 	}
58 | 
59 | 	/**
60 | 	 * Guess the entity class
61 | 	 *
62 | 	 * @param   object  $class  Class instance
63 | 	 *
64 | 	 * @return  string
65 | 	 */
66 | 	public static function parentNamespace($class): string
67 | 	{
68 | 		$namespace = self::namespace($class);
69 | 
70 | 		return substr($namespace, 0, strrpos($namespace, '\\'));
71 | 	}
72 | 
73 | 	/**
74 | 	 * Retrieve class name without namespace.
75 | 	 *
76 | 	 * @param   object  $class  Class instance
77 | 	 *
78 | 	 * @return  string
79 | 	 */
80 | 	public static function withoutNamespace($class): string
81 | 	{
82 | 		return (new \ReflectionClass($class))->getShortName();
83 | 	}
84 | }
85 | 


--------------------------------------------------------------------------------
/src/MVC/Controller/AdminController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Controller;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\MVC\Controller\AdminController as BaseAdminController;
14 | 
15 | /**
16 |  * Base Admin Controller.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | abstract class AdminController extends BaseAdminController
21 | {
22 | 	/**
23 | 	 * The prefix of the models
24 | 	 *
25 | 	 * @var    string
26 | 	 */
27 | 	protected $modelPrefix = null;
28 | 
29 | 	/**
30 | 	 * Constructor.
31 | 	 *
32 | 	 * @param   array  $config  An optional associative array of configuration settings.
33 | 	 *
34 | 	 * @see     \JControllerLegacy
35 | 	 *
36 | 	 * @throws  \Exception
37 | 	 */
38 | 	public function __construct($config = array())
39 | 	{
40 | 		if (null !== $this->modelPrefix)
41 | 		{
42 | 			$this->{'model_prefix'} = $this->modelPrefix;
43 | 		}
44 | 
45 | 		parent::__construct($config);
46 | 	}
47 | 
48 | 	/**
49 | 	 * Gets the name of the latest extending class.
50 | 	 * For a class named ContentControllerArticles will return Articles
51 | 	 *
52 | 	 * @return  string
53 | 	 */
54 | 	public function instanceName()
55 | 	{
56 | 		$class = get_class($this);
57 | 
58 | 		if (false !== strpos($class, '\\'))
59 | 		{
60 | 			return (new \ReflectionClass($this))->getShortName();
61 | 		}
62 | 
63 | 		$name = strstr($class, 'Controller');
64 | 		$name = str_replace('Controller', '', $name);
65 | 
66 | 		return strtolower($name);
67 | 	}
68 | }
69 | 


--------------------------------------------------------------------------------
/src/MVC/Controller/FormController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Controller;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Joomla\CMS\Language\Text;
15 | use Joomla\CMS\MVC\Controller\FormController as BaseFormController;
16 | use Joomla\CMS\Uri\Uri;
17 | use Phproberto\Joomla\Entity\MVC\Request;
18 | use Phproberto\Joomla\Entity\Acl\Contracts\Aclable;
19 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
20 | use Phproberto\Joomla\Entity\Users\Contracts\Ownerable;
21 | use Phproberto\Joomla\Entity\Users\Column as UsersColumn;
22 | use Phproberto\Joomla\Entity\MVC\Controller\Traits\HasAssociatedEntity;
23 | 
24 | /**
25 |  * Base Form Controller.
26 |  *
27 |  * @since  1.0.1
28 |  */
29 | abstract class FormController extends BaseFormController
30 | {
31 | 	use HasAssociatedEntity;
32 | 
33 | 	/**
34 | 	 * Gets the name of the latest extending class.
35 | 	 * For a class named ContentControllerArticles will return Articles
36 | 	 *
37 | 	 * @return  string
38 | 	 */
39 | 	public function instanceName()
40 | 	{
41 | 		$class = get_class($this);
42 | 
43 | 		if (false !== strpos($class, '\\'))
44 | 		{
45 | 			return (new \ReflectionClass($this))->getShortName();
46 | 		}
47 | 
48 | 		$name = strstr($class, 'Controller');
49 | 		$name = str_replace('Controller', '', $name);
50 | 
51 | 		return strtolower($name);
52 | 	}
53 | }
54 | 


--------------------------------------------------------------------------------
/src/MVC/Model/ModelWithStateInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Model\State\StateInterface;
14 | 
15 | /**
16 |  * Represents a model with plugable state classes.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | interface ModelWithStateInterface
21 | {
22 | 	/**
23 | 	 * Retrieve the model state.
24 | 	 *
25 | 	 * @return  StateInterface
26 | 	 */
27 | 	public function state();
28 | }
29 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/BaseQueryModifier.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Base query modifier.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | abstract class BaseQueryModifier
21 | {
22 | 	/**
23 | 	 * Callback to execute if there are values found.
24 | 	 *
25 | 	 * @var  callable|null
26 | 	 */
27 | 	protected $callback;
28 | 
29 | 	/**
30 | 	 * Query to modify.
31 | 	 *
32 | 	 * @var  \JDatabaseQuery\
33 | 	 */
34 | 	protected $query;
35 | 
36 | 	/**
37 | 	 * Constructor.
38 | 	 *
39 | 	 * @param   \JDatabaseQuery  $query     Query to modify
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, callable $callback = null)
43 | 	{
44 | 		$this->callback = $callback;
45 | 		$this->query = $query;
46 | 	}
47 | 
48 | 	/**
49 | 	 * Execute the callback.
50 | 	 *
51 | 	 * @return  void
52 | 	 */
53 | 	protected function callback()
54 | 	{
55 | 		if ($this->callback)
56 | 		{
57 | 			call_user_func_array($this->callback, array($this->query));
58 | 		}
59 | 	}
60 | 
61 | 	/**
62 | 	 * Isolated factory communication to ease testing.
63 | 	 *
64 | 	 * @return  \JDatabaseDriver
65 | 	 *
66 | 	 * @codeCoverageIgnore
67 | 	 */
68 | 	protected function getDbo()
69 | 	{
70 | 		return Factory::getDbo();
71 | 	}
72 | }
73 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/DateGreaterInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class DateGreaterInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$this->query->where(sprintf('%s > %s', $db->qn($this->column), $value));
69 | 		}
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/DateGreaterOrEqualInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class DateGreaterOrEqualInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$this->query->where(sprintf('%s >= %s', $db->qn($this->column), $value));
69 | 		}
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/DateLowerInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class DateLowerInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$this->query->where(sprintf('%s < %s', $db->qn($this->column), $value));
69 | 		}
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/DateLowerOrEqualInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class DateLowerOrEqualInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$this->query->where(sprintf('%s <= %s', $db->qn($this->column), $value));
69 | 		}
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/DateRangeInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class DateRangeInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$dates = array_filter(
69 | 				explode(' - ', $value),
70 | 				function ($date)
71 | 				{
72 | 					$format = "/^'([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])'/";
73 | 
74 | 					return preg_match($format, $date);
75 | 				}
76 | 			);
77 | 
78 | 			if (count($dates) != 2)
79 | 			{
80 | 				continue;
81 | 			}
82 | 
83 | 			$this->query->where(sprintf('%s >= %s', $db->qn($this->column), $dates[0]));
84 | 			$this->query->where(sprintf('%s <= %s', $db->qn($this->column), $dates[1]));
85 | 		}
86 | 	}
87 | }
88 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/NotEmptyColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to check that a column is not empty.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class NotEmptyColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Column where search for values.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $column;
26 | 
27 | 	/**
28 | 	 * Vales that will be considered empty.
29 | 	 *
30 | 	 * @var  array
31 | 	 */
32 | 	protected $emptyValues = [
33 | 		'', '0', '0000-00-00', '0000-00-00 00:00:00'
34 | 	];
35 | 
36 | 	/**
37 | 	 * Constructor.
38 | 	 *
39 | 	 * @param   \JDatabaseQuery  $query     Query to modify
40 | 	 * @param   string           $column    Column where search for NULL value.
41 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
42 | 	 */
43 | 	public function __construct(\JDatabaseQuery$query, string $column, callable $callback = null)
44 | 	{
45 | 		parent::__construct($query, $callback);
46 | 
47 | 		$this->column = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		$this->callback();
58 | 
59 | 		$db = $this->getDbo();
60 | 
61 | 		$values = array_map([$db, 'quote'], $this->emptyValues);
62 | 
63 | 		$this->query->where($db->qn($this->column) . ' IS NOT NULL')
64 | 			->where($db->qn($this->column) . ' NOT IN (' . implode(', ', $values) . ')');
65 | 	}
66 | }
67 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/NotNullInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier .
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class NotNullInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Column where search for values.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $column;
26 | 
27 | 	/**
28 | 	 * Constructor.
29 | 	 *
30 | 	 * @param   \JDatabaseQuery  $query     Query to modify
31 | 	 * @param   string           $column    Column where search for NULL value.
32 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
33 | 	 */
34 | 	public function __construct(\JDatabaseQuery$query, string $column, callable $callback = null)
35 | 	{
36 | 		parent::__construct($query, $callback);
37 | 
38 | 		$this->column = $column;
39 | 	}
40 | 
41 | 	/**
42 | 	 * Apply the query filter.
43 | 	 *
44 | 	 * @return  void
45 | 	 */
46 | 	public function apply()
47 | 	{
48 | 		$this->callback();
49 | 
50 | 		$db = $this->getDbo();
51 | 
52 | 		$this->query->where($db->qn($this->column) . ' IS NOT NULL');
53 | 	}
54 | }
55 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/NullInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class NullInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Column where search for values.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $column;
26 | 
27 | 	/**
28 | 	 * Constructor.
29 | 	 *
30 | 	 * @param   \JDatabaseQuery  $query     Query to modify
31 | 	 * @param   string           $column    Column where search for NULL value.
32 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
33 | 	 */
34 | 	public function __construct(\JDatabaseQuery$query, string $column, callable $callback = null)
35 | 	{
36 | 		parent::__construct($query, $callback);
37 | 
38 | 		$this->column = $column;
39 | 	}
40 | 
41 | 	/**
42 | 	 * Apply the query filter.
43 | 	 *
44 | 	 * @return  void
45 | 	 */
46 | 	public function apply()
47 | 	{
48 | 		$this->callback();
49 | 
50 | 		$db = $this->getDbo();
51 | 
52 | 		$this->query->where($db->qn($this->column) . ' IS NULL');
53 | 	}
54 | }
55 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/QueryModifierInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Represents a query modifier.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | interface QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Modifies the query.
22 | 	 *
23 | 	 * @return  void
24 | 	 */
25 | 	public function apply();
26 | }
27 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/SearchInColumns.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values like in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class SearchInColumns extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Columns where search for values.
29 | 	 *
30 | 	 * @var  array
31 | 	 */
32 | 	protected $columns;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $columns   Columns where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, array $columns, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->columns  = $columns;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		foreach ($this->values as $value)
67 | 		{
68 | 			$like = $db->quote('%' . trim($value, "'") . '%');
69 | 			$whereParts = array();
70 | 
71 | 			foreach ($this->columns as $column)
72 | 			{
73 | 				$whereParts[] = sprintf('%s', $db->qn($column) . ' LIKE ' . $like);
74 | 			}
75 | 
76 | 			$where = sprintf('(%s)', implode(' OR ', $whereParts));
77 | 
78 | 			$this->query->where($where);
79 | 		}
80 | 	}
81 | }
82 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/ValuesInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class ValuesInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Values to search for.
22 | 	 *
23 | 	 * @var  array
24 | 	 */
25 | 	protected $values;
26 | 
27 | 	/**
28 | 	 * Column where search for values.
29 | 	 *
30 | 	 * @var  string
31 | 	 */
32 | 	protected $column;
33 | 
34 | 	/**
35 | 	 * Constructor.
36 | 	 *
37 | 	 * @param   \JDatabaseQuery  $query     Query to modify
38 | 	 * @param   array            $values    Values to search for.
39 | 	 * @param   string           $column    Column where search for values.
40 | 	 * @param   callable|null    $callback  Callback to execute if there are values found.
41 | 	 */
42 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
43 | 	{
44 | 		parent::__construct($query, $callback);
45 | 
46 | 		$this->values   = $values;
47 | 		$this->column   = $column;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Apply the query filter.
52 | 	 *
53 | 	 * @return  void
54 | 	 */
55 | 	public function apply()
56 | 	{
57 | 		if (!$this->values)
58 | 		{
59 | 			return;
60 | 		}
61 | 
62 | 		$this->callback();
63 | 
64 | 		$db = $this->getDbo();
65 | 
66 | 		if (count($this->values) == 1)
67 | 		{
68 | 			$this->query->where($db->qn($this->column) . ' = ' . reset($this->values));
69 | 
70 | 			return;
71 | 		}
72 | 
73 | 		$this->query->where($db->qn($this->column) . ' IN (' . implode(',', $this->values) . ')');
74 | 	}
75 | }
76 | 


--------------------------------------------------------------------------------
/src/MVC/Model/QueryModifier/ValuesNotInColumn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\QueryModifier;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Modifier to select all rows with values are not in a specified list of values.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class ValuesNotInColumn extends BaseQueryModifier implements QueryModifierInterface
19 | {
20 | 	/**
21 | 	 * Constructor.
22 | 	 *
23 | 	 * @param   \JDatabaseQuery  $query     Query to modify
24 | 	 * @param   array            $values    Values to search in the column
25 | 	 * @param   string           $column    [description]
26 | 	 * @param   callable|null    $callback  [description]
27 | 	 */
28 | 	public function __construct(\JDatabaseQuery$query, array $values, string $column, callable $callback = null)
29 | 	{
30 | 		parent::__construct($query, $callback);
31 | 
32 | 		$this->values   = $values;
33 | 		$this->column   = $column;
34 | 	}
35 | 
36 | 	/**
37 | 	 * Apply the query filter.
38 | 	 *
39 | 	 * @return  void
40 | 	 */
41 | 	public function apply()
42 | 	{
43 | 		if (!$this->values)
44 | 		{
45 | 			return;
46 | 		}
47 | 
48 | 		$this->callback();
49 | 
50 | 		$db = $this->getDbo();
51 | 
52 | 		if (count($this->values) == 1)
53 | 		{
54 | 			$this->query->where($db->qn($this->column) . ' <> ' . reset($this->values));
55 | 
56 | 			return;
57 | 		}
58 | 
59 | 		$this->query->where($db->qn($this->column) . ' NOT IN (' . implode(',', $this->values) . ')');
60 | 	}
61 | }
62 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/Boolean.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Boolean values filterer.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class Boolean extends BaseFilter
19 | {
20 | 	/**
21 | 	 * Determine if a value will be used or not.
22 | 	 *
23 | 	 * @param   mixed  $value  Value to filter
24 | 	 *
25 | 	 * @return  boolean
26 | 	 */
27 | 	protected function filterValue($value)
28 | 	{
29 | 		return in_array($value, [true, false], true);
30 | 	}
31 | 
32 | 	/**
33 | 	 * Prepare a value before applying filter.
34 | 	 *
35 | 	 * @param   mixed  $value  Value to prepare
36 | 	 *
37 | 	 * @return  mixed
38 | 	 */
39 | 	protected function prepareValue($value)
40 | 	{
41 | 		$value = parent::prepareValue($value);
42 | 
43 | 		if (!in_array($value, [1, 0,'1', '0', true, false, 'true', 'false'], true))
44 | 		{
45 | 			return null;
46 | 		}
47 | 
48 | 		return 'true' === $value ? true : ('false' === $value ? false : (bool) $value);
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/Custom.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Integer values filterer.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class Custom extends BaseFilter
19 | {
20 | 	/**
21 | 	 * Filter value function.
22 | 	 *
23 | 	 * @var  callable
24 | 	 */
25 | 	private $filterValueFunction;
26 | 
27 | 	/**
28 | 	 * Prepare value function.
29 | 	 *
30 | 	 * @var  callable
31 | 	 */
32 | 	private $prepareValueFunction;
33 | 
34 | 	/**
35 | 	 * Constructorl
36 | 	 *
37 | 	 * @param   callable       $filterValueFunction   Filtering function
38 | 	 * @param   callable|null  $prepareValueFunction  Prepare function
39 | 	 * @param   array          $options               Additional options
40 | 	 */
41 | 	public function __construct(callable $filterValueFunction, callable $prepareValueFunction = null, array $options = [])
42 | 	{
43 | 		parent::__construct($options);
44 | 
45 | 		$this->filterValueFunction = $filterValueFunction;
46 | 		$this->prepareValueFunction = $prepareValueFunction;
47 | 	}
48 | 
49 | 	/**
50 | 	 * Determine if a value will be used or not.
51 | 	 *
52 | 	 * @param   mixed  $value  Value to filter
53 | 	 *
54 | 	 * @return  boolean
55 | 	 */
56 | 	protected function filterValue($value)
57 | 	{
58 | 		return call_user_func($this->filterValueFunction, $value);
59 | 	}
60 | 
61 | 	/**
62 | 	 * Prepare value.
63 | 	 *
64 | 	 * @param   mixed  $value  Value to prepare
65 | 	 *
66 | 	 * @return  mixed
67 | 	 */
68 | 	public function prepareValue($value)
69 | 	{
70 | 		$value = parent::prepareValue($value);
71 | 
72 | 		if (!$this->prepareValueFunction)
73 | 		{
74 | 			return $value;
75 | 		}
76 | 
77 | 		return call_user_func($this->prepareValueFunction, $value);
78 | 	}
79 | }
80 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/DateFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Filter for dates.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class DateFilter extends StringQuoted
21 | {
22 | 	/**
23 | 	 * Determine if a value will be used or not.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to filter
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	protected function filterValue($value)
30 | 	{
31 | 		$format = "/^'([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])'/";
32 | 
33 | 		if (!preg_match($format, $value, $matches))
34 | 		{
35 | 			return false;
36 | 		}
37 | 
38 | 		// Extra year check
39 | 		return $matches[1] > 0;
40 | 	}
41 | 
42 | 	/**
43 | 	 * Prepare value.
44 | 	 *
45 | 	 * @param   mixed  $value  Value to prepare
46 | 	 *
47 | 	 * @return  mixed
48 | 	 */
49 | 	public function prepareValue($value)
50 | 	{
51 | 		$value = parent::prepareValue($value);
52 | 
53 | 		if (!is_string($value) && !is_numeric($value))
54 | 		{
55 | 			return null;
56 | 		}
57 | 
58 | 		return (string) $value;
59 | 	}
60 | }
61 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/DateRangeFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Filter for dates.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class DateRangeFilter extends StringQuoted
21 | {
22 | 	/**
23 | 	 * Determine if a value will be used or not.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to filter
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	protected function filterValue($value)
30 | 	{
31 | 		$format = "/^'([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) - ([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])'/";
32 | 
33 | 		if (!preg_match($format, $value, $test))
34 | 		{
35 | 			return false;
36 | 		}
37 | 
38 | 		// Year check
39 | 		return $test[1] > 0 && $test[4] > 0 && $test[4] > $test[1];
40 | 	}
41 | 
42 | 	/**
43 | 	 * Prepare value.
44 | 	 *
45 | 	 * @param   mixed  $value  Value to prepare
46 | 	 *
47 | 	 * @return  mixed
48 | 	 */
49 | 	public function prepareValue($value)
50 | 	{
51 | 		$value = parent::prepareValue($value);
52 | 
53 | 		if (!is_string($value) && !is_numeric($value))
54 | 		{
55 | 			return null;
56 | 		}
57 | 
58 | 		return (string) $value;
59 | 	}
60 | }
61 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/DateTimeFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Filter for datetime mysql fields.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class DateTimeFilter extends StringQuoted
21 | {
22 | 	/**
23 | 	 * Determine if a value will be used or not.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to filter
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	protected function filterValue($value)
30 | 	{
31 | 		$format = "/^'([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])'/";
32 | 
33 | 		if (!preg_match($format, $value, $matches))
34 | 		{
35 | 			return false;
36 | 		}
37 | 
38 | 		// Extra year check
39 | 		return $matches[1] > 0;
40 | 	}
41 | 
42 | 	/**
43 | 	 * Prepare value.
44 | 	 *
45 | 	 * @param   mixed  $value  Value to prepare
46 | 	 *
47 | 	 * @return  mixed
48 | 	 */
49 | 	public function prepareValue($value)
50 | 	{
51 | 		$value = parent::prepareValue($value);
52 | 
53 | 		if (!is_string($value) && !is_numeric($value))
54 | 		{
55 | 			return null;
56 | 		}
57 | 
58 | 		return (string) $value;
59 | 	}
60 | }
61 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/Escaped.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Strings escaped by database driver.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class Escaped extends StringFilter
21 | {
22 | 	/**
23 | 	 * Prepare value.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to prepare
26 | 	 *
27 | 	 * @return  mixed
28 | 	 */
29 | 	public function prepareValue($value)
30 | 	{
31 | 		$value = parent::prepareValue($value);
32 | 
33 | 		if (!is_string($value))
34 | 		{
35 | 			return null;
36 | 		}
37 | 
38 | 		return $this->getDbo()->escape($value);
39 | 	}
40 | 
41 | 	/**
42 | 	 * Isolated factory communication to ease testing.
43 | 	 *
44 | 	 * @return  \JDatabaseDriver
45 | 	 */
46 | 	protected function getDbo()
47 | 	{
48 | 		return Factory::getDbo();
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/FilterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Methods required by query filterers.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | interface FilterInterface
19 | {
20 | 	/**
21 | 	 * Filter one or more values received from the state.
22 | 	 *
23 | 	 * @param   mixed  $values  Values to filter
24 | 	 *
25 | 	 * @return  array
26 | 	 */
27 | 	public function filter($values);
28 | }
29 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/Integer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Integer values filterer.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class Integer extends BaseFilter
19 | {
20 | 	/**
21 | 	 * Determine if a value will be used or not.
22 | 	 *
23 | 	 * @param   mixed  $value  Value to filter
24 | 	 *
25 | 	 * @return  boolean
26 | 	 */
27 | 	protected function filterValue($value)
28 | 	{
29 | 		return is_int($value);
30 | 	}
31 | 
32 | 	/**
33 | 	 * Prepare value.
34 | 	 *
35 | 	 * @param   mixed  $value  Value to prepare
36 | 	 *
37 | 	 * @return  mixed
38 | 	 */
39 | 	public function prepareValue($value)
40 | 	{
41 | 		return (int) parent::prepareValue($value);
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/IntegerBoolean.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * IntegerBoolean filter. Boolean in binary state: 0 (false) | 1 (true).
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class IntegerBoolean extends Boolean
19 | {
20 | 	/**
21 | 	 * Determine if a value will be used or not.
22 | 	 *
23 | 	 * @param   mixed  $value  Value to filter
24 | 	 *
25 | 	 * @return  boolean
26 | 	 */
27 | 	protected function filterValue($value)
28 | 	{
29 | 		return in_array($value, [0,1], true);
30 | 	}
31 | 
32 | 	/**
33 | 	 * Prepare a value before applying filter.
34 | 	 *
35 | 	 * @param   mixed  $value  Value to prepare
36 | 	 *
37 | 	 * @return  mixed
38 | 	 */
39 | 	protected function prepareValue($value)
40 | 	{
41 | 		$value = parent::prepareValue($value);
42 | 
43 | 		return null === $value ? null : (int) $value;
44 | 	}
45 | }
46 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/PositiveInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * PositiveInteger values filterer.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class PositiveInteger extends Integer
19 | {
20 | 	/**
21 | 	 * Determine if a value will be used or not.
22 | 	 *
23 | 	 * @param   mixed  $value  Value to filter
24 | 	 *
25 | 	 * @return  boolean
26 | 	 */
27 | 	protected function filterValue($value)
28 | 	{
29 | 		return (int) $value > 0;
30 | 	}
31 | }
32 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/StringFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Filter for strings.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class StringFilter extends BaseFilter
21 | {
22 | 	/**
23 | 	 * Determine if a value will be used or not.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to filter
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	protected function filterValue($value)
30 | 	{
31 | 		return is_string($value);
32 | 	}
33 | 
34 | 	/**
35 | 	 * Prepare value.
36 | 	 *
37 | 	 * @param   mixed  $value  Value to prepare
38 | 	 *
39 | 	 * @return  mixed
40 | 	 */
41 | 	public function prepareValue($value)
42 | 	{
43 | 		$value = parent::prepareValue($value);
44 | 
45 | 		if (!is_string($value) && !is_numeric($value))
46 | 		{
47 | 			return null;
48 | 		}
49 | 
50 | 		return (string) $value;
51 | 	}
52 | }
53 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Filter/StringQuoted.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State\Filter;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | 
15 | /**
16 |  * Filter to quote strings.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | class StringQuoted extends StringFilter
21 | {
22 | 	/**
23 | 	 * Determine if a value will be used or not.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to filter
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	protected function filterValue($value)
30 | 	{
31 | 		$value = (string) $value;
32 | 
33 | 		return "'" === $value[0] && "'" === $value[strlen($value) - 1];
34 | 	}
35 | 
36 | 	/**
37 | 	 * Prepare value.
38 | 	 *
39 | 	 * @param   mixed  $value  Value to prepare
40 | 	 *
41 | 	 * @return  mixed
42 | 	 */
43 | 	public function prepareValue($value)
44 | 	{
45 | 		$value = parent::prepareValue($value);
46 | 
47 | 		if (!is_string($value))
48 | 		{
49 | 			return null;
50 | 		}
51 | 
52 | 		return $this->getDbo()->quote($value);
53 | 	}
54 | 
55 | 	/**
56 | 	 * Isolated factory communication to ease testing.
57 | 	 *
58 | 	 * @return  \JDatabaseDriver
59 | 	 */
60 | 	protected function getDbo()
61 | 	{
62 | 		return Factory::getDbo();
63 | 	}
64 | }
65 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/FilteredProperty.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\MVC\Model\State\PropertyInterface;
14 | use Phproberto\Joomla\Entity\MVC\Model\State\Filter\StringQuoted;
15 | use Phproberto\Joomla\Entity\MVC\Model\State\Filter\FilterInterface;
16 | 
17 | /**
18 |  * Represents a state property.
19 |  *
20 |  * @since  __DEPLOY_VERSION__
21 |  */
22 | class FilteredProperty implements PropertyInterface
23 | {
24 | 	/**
25 | 	 * Property value filter.
26 | 	 *
27 | 	 * @var  FilterInterface
28 | 	 */
29 | 	protected $filter;
30 | 
31 | 	/**
32 | 	 * Property being filtered.
33 | 	 *
34 | 	 * @var  PropertyInterface
35 | 	 */
36 | 	protected $property;
37 | 
38 | 	/**
39 | 	 * Constructor
40 | 	 *
41 | 	 * @param   PropertyInterface  $property  Property
42 | 	 * @param   FilterInterface    $filter    Filter used to retrieve values
43 | 	 */
44 | 	public function __construct(PropertyInterface $property, FilterInterface $filter = null)
45 | 	{
46 | 		$this->property = $property;
47 | 		$this->filter = $filter ?: new StringQuoted;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Redirect any missing method call to decorated property.
52 | 	 *
53 | 	 * @param   string  $method  Method name
54 | 	 * @param   array   $params  Method parameters
55 | 	 *
56 | 	 * @return  mixed
57 | 	 */
58 | 	public function __call($method, $params)
59 | 	{
60 | 		return call_user_func_array([$this->property, $method], $params);
61 | 	}
62 | 
63 | 	/**
64 | 	 * Filter a value for this property.
65 | 	 *
66 | 	 * @param   mixed  $value  Value to filter
67 | 	 *
68 | 	 * @return  mixed
69 | 	 */
70 | 	public function filter($value)
71 | 	{
72 | 		return $this->filter->filter($value);
73 | 	}
74 | 
75 | 	/**
76 | 	 * Can this property be populated from request?
77 | 	 *
78 | 	 * @return  boolean
79 | 	 */
80 | 	public function isPopulable()
81 | 	{
82 | 		return $this->property->isPopulable();
83 | 	}
84 | 
85 | 	/**
86 | 	 * Retrieve the property identifier.
87 | 	 *
88 | 	 * @return  string
89 | 	 */
90 | 	public function key()
91 | 	{
92 | 		return $this->property->key();
93 | 	}
94 | }
95 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/FilteredState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\MVC\Model\BaseDatabaseModel;
14 | use Phproberto\Joomla\Entity\MVC\Model\State\Filter\StringQuoted;
15 | 
16 | /**
17 |  * Represents a filtered model state.
18 |  *
19 |  * @since  __DEPLOY_VERSION__
20 |  */
21 | class FilteredState extends State
22 | {
23 | 	/**
24 | 	 * Get a value from the state.
25 | 	 *
26 | 	 * @param   string  $key      State property key
27 | 	 * @param   mixed   $default  Default value
28 | 	 *
29 | 	 * @return  mixed
30 | 	 */
31 | 	public function get($key, $default = null)
32 | 	{
33 | 		$value = parent::get($key, $default);
34 | 
35 | 		try
36 | 		{
37 | 			return $this->property($key)->filter($value);
38 | 		}
39 | 		catch (\RuntimeException $e)
40 | 		{
41 | 			$filter = new StringQuoted;
42 | 
43 | 			return $filter->filter($value);
44 | 		}
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/PopulableProperty.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Represents a state property.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class PopulableProperty extends Property
19 | {
20 | 	/**
21 | 	 * Can this property be populated from request?
22 | 	 *
23 | 	 * @var  boolean
24 | 	 */
25 | 	protected $isPopulable = true;
26 | }
27 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/Property.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Represents a state property.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | class Property implements PropertyInterface
19 | {
20 | 	/**
21 | 	 * Property identifier.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $key;
26 | 
27 | 	/**
28 | 	 * Can this property be populated from request?
29 | 	 *
30 | 	 * @var  boolean
31 | 	 */
32 | 	protected $isPopulable = false;
33 | 
34 | 	/**
35 | 	 * Constructor
36 | 	 *
37 | 	 * @param   string  $key  Property identifier. Example: list.limit
38 | 	 *
39 | 	 * @throws  \RuntimeException
40 | 	 */
41 | 	public function __construct($key)
42 | 	{
43 | 		$key = trim($key);
44 | 
45 | 		if (empty($key))
46 | 		{
47 | 			throw new \RuntimeException('Missing key for model state property');
48 | 		}
49 | 
50 | 		$this->key = $key;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Retrieve the property identifier.
55 | 	 *
56 | 	 * @return  string
57 | 	 */
58 | 	public function key()
59 | 	{
60 | 		return $this->key;
61 | 	}
62 | 
63 | 	/**
64 | 	 * Can this property be populated from request?
65 | 	 *
66 | 	 * @return  boolean
67 | 	 */
68 | 	public function isPopulable()
69 | 	{
70 | 		return $this->isPopulable;
71 | 	}
72 | }
73 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/PropertyInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Represents a model state property.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | interface PropertyInterface
19 | {
20 | 	/**
21 | 	 * Can this property be populated from request?
22 | 	 *
23 | 	 * @return  boolean
24 | 	 */
25 | 	public function isPopulable();
26 | 
27 | 	/**
28 | 	 * Retrieve the property identifier.
29 | 	 *
30 | 	 * @return  string
31 | 	 */
32 | 	public function key();
33 | }
34 | 


--------------------------------------------------------------------------------
/src/MVC/Model/State/StateInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\State;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Methods required by query filterers.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | interface StateInterface
19 | {
20 | 	/**
21 | 	 * Get a value from the state.
22 | 	 *
23 | 	 * @param   string  $key      Property key
24 | 	 * @param   mixed   $default  Default value
25 | 	 *
26 | 	 * @return  mixed
27 | 	 */
28 | 	public function get($key, $default = null);
29 | 
30 | 	/**
31 | 	 * Set a value of a state property.
32 | 	 *
33 | 	 * @param   string  $key    Property key
34 | 	 * @param   mixed   $value  Value for the state property
35 | 	 *
36 | 	 * @return  mixed  The previous value of the property or null if not set.
37 | 	 */
38 | 	public function set($key, $value);
39 | }
40 | 


--------------------------------------------------------------------------------
/src/MVC/Model/Traits/HasContext.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * For models with extended context functions.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasContext
19 | {
20 | 	/**
21 | 	 * Context string for the model type.  This is used to handle uniqueness
22 | 	 * when dealing with the getStoreId() method and caching data structures.
23 | 	 *
24 | 	 * @var    string
25 | 	 */
26 | 	protected $context = null;
27 | 
28 | 	/**
29 | 	 * Gets the model context.
30 | 	 *
31 | 	 * @return  string  The context
32 | 	 */
33 | 	public function getContext()
34 | 	{
35 | 		return $this->context;
36 | 	}
37 | 
38 | 	/**
39 | 	 * Sets the context.
40 | 	 *
41 | 	 * @param   string  $context  The context
42 | 	 *
43 | 	 * @return  void
44 | 	 */
45 | 	public function setContext($context)
46 | 	{
47 | 		$this->context = $context;
48 | 	}
49 | }
50 | 


--------------------------------------------------------------------------------
/src/MVC/Model/Traits/HasFilteredState.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\MVC\Model\State\FilteredState;
14 | use Phproberto\Joomla\Entity\MVC\Model\State\Filter;
15 | use Phproberto\Joomla\Entity\MVC\Model\State\FilteredProperty;
16 | use Phproberto\Joomla\Entity\MVC\Model\State\PopulableProperty;
17 | 
18 | /**
19 |  * For list models with search functions.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | trait HasFilteredState
24 | {
25 | 	/**
26 | 	 * Retrieve the model state.
27 | 	 *
28 | 	 * @return  FilteredState
29 | 	 */
30 | 	public function state()
31 | 	{
32 | 		return new FilteredState($this, $this->stateProperties());
33 | 	}
34 | 
35 | 	/**
36 | 	 * Get the properties that will be available in this model state.
37 | 	 *
38 | 	 * @return  array
39 | 	 */
40 | 	protected function stateProperties()
41 | 	{
42 | 		return [
43 | 			'list.limit' => new FilteredProperty(
44 | 				new PopulableProperty('list.limit'),
45 | 				new Filter\Integer
46 | 			),
47 | 			'list.start' => new FilteredProperty(
48 | 				new PopulableProperty('list.start'),
49 | 				new Filter\Integer
50 | 			)
51 | 		];
52 | 	}
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/src/MVC/Model/Traits/HasQueryModifiers.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\MVC\Model\QueryModifier\QueryModifierInterface;
14 | 
15 | /**
16 |  * Trait for models with query modifiers.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | trait HasQueryModifiers
21 | {
22 | 	/**
23 | 	 * Apply a query modifier.
24 | 	 *
25 | 	 * @param   QueryModifierInterface  $modifier  [description]
26 | 	 *
27 | 	 * @return  void
28 | 	 */
29 | 	public function applyQueryModifier(QueryModifierInterface $modifier)
30 | 	{
31 | 		$modifier->apply();
32 | 	}
33 | 
34 | 	/**
35 | 	 * Apply an array of query modifiers.
36 | 	 *
37 | 	 * @param   QueryModifierInterface[]  $modifiers  Query modifiers to apply
38 | 	 *
39 | 	 * @return  void
40 | 	 */
41 | 	public function applyQueryModifiers(array $modifiers)
42 | 	{
43 | 		foreach ($modifiers as $modifier)
44 | 		{
45 | 			$modifier->apply();
46 | 		}
47 | 	}
48 | }
49 | 


--------------------------------------------------------------------------------
/src/MVC/Model/Traits/HasSearch.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\Model\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | 
15 | /**
16 |  * For list models with search functions.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | trait HasSearch
21 | {
22 | 	/**
23 | 	 * Method to get an array of data items. Overriden to add static cache support.
24 | 	 *
25 | 	 * @return  array
26 | 	 */
27 | 	abstract public function getItems();
28 | 
29 | 	/**
30 | 	 * Method to set model state variables
31 | 	 *
32 | 	 * @param   string  $property  The name of the property.
33 | 	 * @param   mixed   $value     The value of the property to set or null.
34 | 	 *
35 | 	 * @return  mixed  The previous value of the property or null if not set.
36 | 	 */
37 | 	abstract public function setState($property, $value = null);
38 | 
39 | 	/**
40 | 	 * Method to search items based on a state.
41 | 	 *
42 | 	 * Note: This method clears the model state.
43 | 	 *
44 | 	 * @param   array  $state  Array with filters + list options
45 | 	 *
46 | 	 * @return  array
47 | 	 */
48 | 	public function search($state = array())
49 | 	{
50 | 		// Clear current state and avoid populateState
51 | 		$this->state = new \JObject;
52 | 		$this->{'__state_set'} = true;
53 | 
54 | 		foreach ($state as $key => $value)
55 | 		{
56 | 			$this->setState($key, $value);
57 | 		}
58 | 
59 | 		return $this->getItems();
60 | 	}
61 | 
62 | 	/**
63 | 	 * Search items and return a collection of entities with the results of ->search()
64 | 	 *
65 | 	 * @param   string  $entityClass  Entity to bind item data
66 | 	 * @param   array   $state        Model state
67 | 	 *
68 | 	 * @return  Collection
69 | 	 */
70 | 	public function searchCollection(string $entityClass, array $state = [])
71 | 	{
72 | 		return new Collection(
73 | 			array_map(
74 | 				function ($entityData) use ($entityClass)
75 | 				{
76 | 					$entity = new $entityClass;
77 | 					$id = $entityData->{$entity->primaryKey()};
78 | 
79 | 					return $entityClass::find($id)->bind($entityData);
80 | 				},
81 | 				$this->search($state)
82 | 			)
83 | 		);
84 | 	}
85 | }
86 | 


--------------------------------------------------------------------------------
/src/MVC/View/FormView.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\View;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\MVC\View\HTMLView;
14 | 
15 | /**
16 |  * Base form view.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | abstract class FormView extends HTMLView
21 | {
22 | 	/**
23 | 	 * Load layout data.
24 | 	 *
25 | 	 * @return  self
26 | 	 */
27 | 	protected function loadLayoutData()
28 | 	{
29 | 		$model = $this->getModel();
30 | 
31 | 		return array_merge(
32 | 			parent::loadLayoutData(),
33 | 			[
34 | 				'form'  => $model->getForm(),
35 | 				'model' => $model
36 | 			]
37 | 		);
38 | 	}
39 | }
40 | 


--------------------------------------------------------------------------------
/src/MVC/View/ItemView.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\View;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Joomla\CMS\Language\Text;
15 | use Phproberto\Joomla\Entity\MVC\View\HTMLView;
16 | use Phproberto\Joomla\Entity\Contracts\AssociatedEntity;
17 | 
18 | /**
19 |  * Base item view.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | abstract class ItemView extends HTMLView
24 | {
25 | 	/**
26 | 	 * Allow to check access to the view in child classes.
27 | 	 *
28 | 	 * @param   string  $tpl  Layout being rendered
29 | 	 *
30 | 	 * @return  boolean
31 | 	 */
32 | 	protected function allowLayout($tpl = null)
33 | 	{
34 | 		if (!$this instanceof AssociatedEntity)
35 | 		{
36 | 			return true;
37 | 		}
38 | 
39 | 		$entityClass = $this->entityClass();
40 | 		$entity = new $entityClass;
41 | 		$entity->bind($this->getLayoutData()['item']->getProperties(true));
42 | 
43 | 		if (!$entity->acl()->canView())
44 | 		{
45 | 			$msg = Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN');
46 | 
47 | 			$this->addMessage($msg, 'error');
48 | 
49 | 			return false;
50 | 		}
51 | 
52 | 		return true;
53 | 	}
54 | 
55 | 
56 | 	/**
57 | 	 * Load layout data.
58 | 	 *
59 | 	 * @return  self
60 | 	 */
61 | 	protected function loadLayoutData()
62 | 	{
63 | 		$model = $this->getModel();
64 | 
65 | 		$data = array_merge(
66 | 			parent::loadLayoutData(),
67 | 			[
68 | 				'item'   => $model->getItem(),
69 | 				'return' => Factory::getApplication()->input->getString('return', ''),
70 | 				'model'  => $model
71 | 			]
72 | 		);
73 | 
74 | 		if ($this instanceof AssociatedEntity)
75 | 		{
76 | 			$entityClass = $this->entityClass();
77 | 			$parts = explode('\\', $entityClass);
78 | 			$entityName = lcfirst(end($parts));
79 | 			$data['entity'] = $entityClass::find($data['item']->id)->bind($data['item']->getProperties(true));
80 | 			$data[$entityName] = $data['entity'];
81 | 		}
82 | 
83 | 		return $data;
84 | 	}
85 | }
86 | 


--------------------------------------------------------------------------------
/src/MVC/View/ListView.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\MVC\View;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\String\Inflector;
14 | use Phproberto\Joomla\Entity\Collection;
15 | use Phproberto\Joomla\Entity\MVC\View\HTMLView;
16 | use Phproberto\Joomla\Entity\Contracts\AssociatedEntity;
17 | 
18 | /**
19 |  * Base list view.
20 |  *
21 |  * @since  __DEPLOY_VERSION__
22 |  */
23 | abstract class ListView extends HTMLView
24 | {
25 | 	/**
26 | 	 * Load layout data.
27 | 	 *
28 | 	 * @return  self
29 | 	 */
30 | 	protected function loadLayoutData()
31 | 	{
32 | 		$model = $this->getModel();
33 | 
34 | 		$data = array_merge(
35 | 			parent::loadLayoutData(),
36 | 			[
37 | 				'items'         => $model->getItems(),
38 | 				'state'         => $model->getState(),
39 | 				'pagination'    => $model->getPagination(),
40 | 				'filterForm'    => $model->getFilterForm(),
41 | 				'activeFilters' => $model->getActiveFilters(),
42 | 				'model'         => $model
43 | 			]
44 | 		);
45 | 
46 | 		if ($this instanceof AssociatedEntity)
47 | 		{
48 | 			$entityClass = $this->entityClass();
49 | 			$parts = explode('\\', $entityClass);
50 | 			$entityName = lcfirst(end($parts));
51 | 			$entitiesName = Inflector::getInstance()->toPlural($entityName);
52 | 
53 | 			$data['entities'] = new Collection(
54 | 				array_map(
55 | 					function ($itemData) use ($entityClass)
56 | 					{
57 | 						return $entityClass::find($itemData->{'id'})->bind($itemData);
58 | 					},
59 | 					$data['items']
60 | 				)
61 | 			);
62 | 
63 | 			$data[$entitiesName] = $data['entities'];
64 | 		}
65 | 
66 | 		foreach ($data as $key => $value)
67 | 		{
68 | 			if ('view' === $key)
69 | 			{
70 | 				continue;
71 | 			}
72 | 
73 | 			$this->{$key} = $value;
74 | 		}
75 | 
76 | 		return $data;
77 | 	}
78 | }
79 | 


--------------------------------------------------------------------------------
/src/Messages/Message.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Messages;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\ComponentEntity;
14 | 
15 | /**
16 |  * Message entity.
17 |  *
18 |  * @since   1.6.0
19 |  */
20 | class Message extends ComponentEntity
21 | {
22 | 	/**
23 | 	 * Get entity primary key column.
24 | 	 *
25 | 	 * @return  string
26 | 	 */
27 | 	public function primaryKey()
28 | 	{
29 | 		return 'message_id';
30 | 	}
31 | 
32 | 	/**
33 | 	 * Get a table instance. Defauts to \JTableUser.
34 | 	 *
35 | 	 * @param   string  $name     Table name. Optional.
36 | 	 * @param   string  $prefix   Class prefix. Optional.
37 | 	 * @param   array   $options  Configuration array for the table. Optional.
38 | 	 *
39 | 	 * @return  \JTable
40 | 	 *
41 | 	 * @throws  \InvalidArgumentException
42 | 	 */
43 | 	public function table($name = '', $prefix = null, $options = array())
44 | 	{
45 | 		\JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_messages/tables');
46 | 
47 | 		$name   = $name ?: 'Message';
48 | 		$prefix = $prefix ?: 'MessagesTable';
49 | 
50 | 		return parent::table($name, $prefix, $options);
51 | 	}
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Searcher/BaseSearcher.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Searcher;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\Registry\Registry;
14 | 
15 | /**
16 |  * Base searcher.
17 |  *
18 |  * @since  1.4.0
19 |  */
20 | abstract class BaseSearcher
21 | {
22 | 	/**
23 | 	 * Find options.
24 | 	 *
25 | 	 * @var  Registry
26 | 	 */
27 | 	protected $options;
28 | 
29 | 	/**
30 | 	 * Constructor
31 | 	 *
32 | 	 * @param   array  $options  Find options
33 | 	 */
34 | 	public function __construct(array $options = [])
35 | 	{
36 | 		$this->options = new Registry(array_merge($this->defaultOptions(), $options));
37 | 		$this->options->separator = '|';
38 | 	}
39 | 
40 | 	/**
41 | 	 * Default options to initialise searcher.
42 | 	 *
43 | 	 * @return  array
44 | 	 */
45 | 	public function defaultOptions()
46 | 	{
47 | 		return [];
48 | 	}
49 | 
50 | 	/**
51 | 	 * Factory method.
52 | 	 *
53 | 	 * @param   array   $options  Options for the searcher.
54 | 	 *
55 | 	 * @return  static
56 | 	 */
57 | 	public static function instance(array $options = [])
58 | 	{
59 | 		return new static($options);
60 | 	}
61 | 
62 | 	/**
63 | 	 * Retrieve searcher options.
64 | 	 *
65 | 	 * @return  Registry
66 | 	 */
67 | 	public function options()
68 | 	{
69 | 		return $this->options;
70 | 	}
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Searcher/SearcherInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Searcher;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Searcher interface.
15 |  *
16 |  * @since  1.4.0
17 |  */
18 | interface SearcherInterface
19 | {
20 | 	/**
21 | 	 * Execute the search.
22 | 	 *
23 | 	 * @return  array
24 | 	 */
25 | 	public function search();
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Table/TableFinder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | 
10 | namespace Phproberto\Joomla\Entity\Table;
11 | 
12 | defined('_JEXEC') || die;
13 | 
14 | use Joomla\CMS\Table\Table;
15 | use Phproberto\Joomla\Entity\Extensions\Entity\Component;
16 | 
17 | /**
18 |  * Table finder
19 |  *
20 |  * @since  __DEPLOY_VERSION__
21 |  */
22 | abstract class TableFinder
23 | {
24 | 	/**
25 | 	 * Find table in frontend.
26 | 	 *
27 | 	 * @param   string  $name    Name of the table to load. Example: Article
28 | 	 * @param   string  $option  Option of the component where the table is. null = auto-detect. Example: com_content
29 | 	 * @param   array   $config  Optional array of configuration for the table
30 | 	 *
31 | 	 * @return  \JTable
32 | 	 *
33 | 	 * @throws  \InvalidArgumentException  If table not found
34 | 	 */
35 | 	public static function find($name, $option = null, array $config = [])
36 | 	{
37 | 		$component = Component::fromOption($option);
38 | 		$prefix = $component->prefix() . 'Table';
39 | 
40 | 		Table::addIncludePath(JPATH_ADMINISTRATOR . '/components/' . $component->option() . '/tables');
41 | 
42 | 		$table = Table::getInstance($name, $prefix, $config);
43 | 
44 | 		if (!$table instanceof Table)
45 | 		{
46 | 			throw new \InvalidArgumentException(
47 | 				sprintf('Cannot find the table %s in component %s.', $name, $option)
48 | 			);
49 | 		}
50 | 
51 | 		return $table;
52 | 	}
53 | }
54 | 


--------------------------------------------------------------------------------
/src/Table/TableInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by tables.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | interface TableInterface
19 | {
20 | 	/**
21 | 	 * Gets the name of the latest extending class.
22 | 	 * For a class named ContentTableArticles will return Articles
23 | 	 *
24 | 	 * @return  string
25 | 	 */
26 | 	public function getInstanceName();
27 | 
28 | 	/**
29 | 	 * Get the class prefix
30 | 	 *
31 | 	 * @return  string
32 | 	 */
33 | 	public function getInstancePrefix();
34 | 
35 | 	/**
36 | 	 * Compare this table with another one to see if they contain the same entity.
37 | 	 *
38 | 	 * @param   TableInterface  $table  Table to compare
39 | 	 *
40 | 	 * @return  boolean
41 | 	 */
42 | 	public function hasSameKeys(TableInterface $table);
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasAsset.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Table\Table;
14 | 
15 | /**
16 |  * Table with assets.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | trait HasAsset
21 | {
22 | 	/**
23 | 	 * Get the asset prefix.
24 | 	 *
25 | 	 * @return  string
26 | 	 */
27 | 	protected function getAssetPrefix()
28 | 	{
29 | 		return '';
30 | 	}
31 | 
32 | 	/**
33 | 	 * Method to compute the default name of the asset.
34 | 	 * The default name is in the form table_name.id
35 | 	 * where id is the value of the primary key of the table.
36 | 	 *
37 | 	 * @return  string
38 | 	 */
39 | 	protected function getAssetName()
40 | 	{
41 | 		$keys = array();
42 | 
43 | 		foreach ($this->{'_tbl_keys'} as $k)
44 | 		{
45 | 			$keys[] = (int) $this->$k;
46 | 		}
47 | 
48 | 		$prefix = $this->getAssetPrefix();
49 | 
50 | 		return ($prefix ? $prefix . '.' : '') . strtolower($this->getInstanceName()) . '.' . implode('.', $keys);
51 | 	}
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasFixedGetProperties.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Tables with fixed getProperties method.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasFixedGetProperties
19 | {
20 | 	/**
21 | 	 * Override the shit JObject getProperties method
22 | 	 *
23 | 	 * @param   boolean  $public  Load only public properties?
24 | 	 *
25 | 	 * @return  array
26 | 	 */
27 | 	public function getProperties($public = true)
28 | 	{
29 | 		if ($public)
30 | 		{
31 | 			$vars = [];
32 | 			$object = new \ReflectionObject($this);
33 | 			$properties = $object->getProperties(\ReflectionProperty::IS_PUBLIC);
34 | 
35 | 			foreach ($properties as $property)
36 | 			{
37 | 				// For B/C we will keep the shit underscore private identification
38 | 				if ('_' == substr($property->name, 0, 1))
39 | 				{
40 | 					continue;
41 | 				}
42 | 
43 | 				$vars[$property->name] = $this->{$property->name};
44 | 			}
45 | 
46 | 			return $vars;
47 | 		}
48 | 
49 | 		return get_object_vars($this);
50 | 	}
51 | }
52 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasInstanceName.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Tables with instance name.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasInstanceName
19 | {
20 | 	/**
21 | 	 * Name of the instance.
22 | 	 *
23 | 	 * @var    string
24 | 	 */
25 | 	protected $instanceName;
26 | 
27 | 	/**
28 | 	 * Gets the name of the latest extending class.
29 | 	 * For a class named ContentTableArticles will return Articles
30 | 	 *
31 | 	 * @return  string
32 | 	 */
33 | 	public function getInstanceName()
34 | 	{
35 | 		if (null === $this->instanceName)
36 | 		{
37 | 			$this->instanceName = strtolower(str_replace('Table', '', strstr(get_class($this), 'Table')));
38 | 		}
39 | 
40 | 		return $this->instanceName;
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasInstancePrefix.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Tables with instance prefix.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasInstancePrefix
19 | {
20 | 	/**
21 | 	 * Instance prefix used for autoloading + events.
22 | 	 *
23 | 	 * @var    string
24 | 	 */
25 | 	protected $instancePrefix;
26 | 
27 | 	/**
28 | 	 * Get the class prefix
29 | 	 *
30 | 	 * @return  string
31 | 	 */
32 | 	public function getInstancePrefix()
33 | 	{
34 | 		if (null === $this->instancePrefix)
35 | 		{
36 | 			$this->instancePrefix = strtolower(strstr(get_class($this), 'Table', true));
37 | 		}
38 | 
39 | 		return $this->instancePrefix;
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasKeysComparator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Table\TableInterface;
14 | 
15 | /**
16 |  * Tables with keys comparisions.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | trait HasKeysComparator
21 | {
22 | 	/**
23 | 	 * Compare this table with another one to see if they contain the same entity.
24 | 	 *
25 | 	 * @param   TableInterface  $table  Table to compare
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	public function hasSameKeys(TableInterface $table)
30 | 	{
31 | 		foreach ($this->{'_tbl_keys'} as $k)
32 | 		{
33 | 			if (!property_exists($this, $k) || $this->{$k} !== $table->{$k})
34 | 			{
35 | 				return false;
36 | 			}
37 | 		}
38 | 
39 | 		return true;
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Table/Traits/HasLanguageStrings.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     Joomla.Entity
 4 |  * @subpackage  Table
 5 |  *
 6 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 7 |  * @license    See COPYING.txt
 8 |  */
 9 | namespace Phproberto\Joomla\Entity\Table\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Tables with language strings.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasLanguageStrings
19 | {
20 | 	/**
21 | 	 * Text prefix for language strings.
22 | 	 *
23 | 	 * @var  string
24 | 	 */
25 | 	protected $textPrefix;
26 | 
27 | 	/**
28 | 	 * Get the text prefix to use for language strings
29 | 	 *
30 | 	 * @return  string
31 | 	 */
32 | 	public function getTextPrefix()
33 | 	{
34 | 		if (empty($this->textPrefix))
35 | 		{
36 | 			$this->textPrefix = 'LIB_' . strtoupper($this->getInstancePrefix()) . '_' . strtoupper($this->getInstanceName());
37 | 		}
38 | 
39 | 		return $this->textPrefix;
40 | 	}
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Tags/Tag.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Tags;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\ComponentEntity;
14 | use Phproberto\Joomla\Entity\Acl\Traits\HasAcl;
15 | use Phproberto\Joomla\Entity\Acl\Contracts\Aclable;
16 | use Phproberto\Joomla\Entity\Core\Traits as CoreTraits;
17 | use Phproberto\Joomla\Entity\Core\Contracts\Publishable;
18 | 
19 | /**
20 |  * Tag entity.
21 |  *
22 |  * @since   1.0.0
23 |  */
24 | class Tag extends ComponentEntity implements Aclable, Publishable
25 | {
26 | 	use HasAcl;
27 | 	use CoreTraits\HasImages, CoreTraits\HasLink, CoreTraits\HasMetadata, CoreTraits\HasParams, CoreTraits\HasState;
28 | 
29 | 	/**
30 | 	 * Get a table.
31 | 	 *
32 | 	 * @param   string  $name     The table name. Optional.
33 | 	 * @param   string  $prefix   The class prefix. Optional.
34 | 	 * @param   array   $options  Configuration array for model. Optional.
35 | 	 *
36 | 	 * @return  \JTable
37 | 	 *
38 | 	 * @codeCoverageIgnore
39 | 	 */
40 | 	public function table($name = '', $prefix = null, $options = array())
41 | 	{
42 | 		\JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_tags/tables');
43 | 
44 | 		$name = $name ?: 'Tag';
45 | 		$prefix = $prefix ?: 'TagsTable';
46 | 
47 | 		return parent::table($name, $prefix, $options);
48 | 	}
49 | 
50 | 	/**
51 | 	 * Load the link to this entity.
52 | 	 *
53 | 	 * @return  atring
54 | 	 *
55 | 	 * @codeCoverageIgnore
56 | 	 */
57 | 	protected function loadLink()
58 | 	{
59 | 		if (!$this->hasId())
60 | 		{
61 | 			return null;
62 | 		}
63 | 
64 | 		\JLoader::register('TagsHelperRoute', JPATH_BASE . '/components/com_tags/helpers/route.php');
65 | 
66 | 		return \JRoute::_(\TagsHelperRoute::getTagRoute($this->id() . '-' . $this->get('alias')));
67 | 	}
68 | }
69 | 


--------------------------------------------------------------------------------
/src/Traits/HasApp.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Joomla\CMS\Application\CMSApplication;
15 | 
16 | /**
17 |  * For classes having a linked app.
18 |  *
19 |  * @since  __DEPLOY_VERSION__
20 |  */
21 | trait HasApp
22 | {
23 | 	/**
24 | 	 * Active application.
25 | 	 *
26 | 	 * @var  CMSApplication
27 | 	 */
28 | 	protected $app;
29 | 
30 | 	/**
31 | 	 * Retrieve the active application.
32 | 	 *
33 | 	 * @return  CMSApplication
34 | 	 */
35 | 	protected function activeApplication()
36 | 	{
37 | 		return Factory::getApplication();
38 | 	}
39 | 
40 | 	/**
41 | 	 * Retrieve the active application.
42 | 	 *
43 | 	 * @return  CMSApplication
44 | 	 */
45 | 	protected function app()
46 | 	{
47 | 		if (null === $this->app)
48 | 		{
49 | 			$this->app = $this->activeApplication();
50 | 		}
51 | 
52 | 		return $this->app;
53 | 	}
54 | }
55 | 


--------------------------------------------------------------------------------
/src/Traits/HasLayoutData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * For classes having cached layout data.
15 |  *
16 |  * @since  __DEPLOY_VERSION__
17 |  */
18 | trait HasLayoutData
19 | {
20 | 	/**
21 | 	 * Layout data for the views.
22 | 	 *
23 | 	 * @var    array
24 | 	 */
25 | 	protected $layoutData = [];
26 | 
27 | 	/**
28 | 	 * Get the data that will be sent to twig.
29 | 	 *
30 | 	 * @return  array
31 | 	 */
32 | 	protected function getLayoutData()
33 | 	{
34 | 		if (!isset($this->layoutData[__CLASS__]))
35 | 		{
36 | 			$this->layoutData[__CLASS__] = $this->loadLayoutData();
37 | 		}
38 | 
39 | 		return $this->layoutData[__CLASS__];
40 | 	}
41 | 
42 | 	/**
43 | 	 * Load layout data.
44 | 	 *
45 | 	 * @return  array
46 | 	 */
47 | 	abstract protected function loadLayoutData();
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Traits/HasMessages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Application\CMSApplication;
14 | 
15 | /**
16 |  * For classes having messages.
17 |  *
18 |  * @since  __DEPLOY_VERSION__
19 |  */
20 | trait HasMessages
21 | {
22 | 	/**
23 | 	 * System messages for the user.
24 | 	 *
25 | 	 * @var   array
26 | 	 */
27 | 	protected $messages = [];
28 | 
29 | 	/**
30 | 	 * Adds a system message.
31 | 	 *
32 | 	 * @param   string  $message  Message to show
33 | 	 * @param   string  $type     Type of message
34 | 	 *
35 | 	 * @return  self.
36 | 	 */
37 | 	protected function addMessage($message, $type = 'message')
38 | 	{
39 | 		if (!isset($this->messages[$type]))
40 | 		{
41 | 			$this->messages[$type] = array();
42 | 		}
43 | 
44 | 		$this->messages[$type][] = $message;
45 | 
46 | 		return $this;
47 | 	}
48 | 
49 | 	/**
50 | 	 * Inject any pending message into the Joomla app.
51 | 	 *
52 | 	 * @param   CMSApplication  $app  Application to inject the messages
53 | 	 *
54 | 	 * @return  self
55 | 	 */
56 | 	protected function enqueueMessagesInApp(CMSApplication $app)
57 | 	{
58 | 		$systemMessages = $this->getMessages();
59 | 
60 | 		if (!$systemMessages)
61 | 		{
62 | 			return $this;
63 | 		}
64 | 
65 | 		foreach ($systemMessages as $messageType => $messages)
66 | 		{
67 | 			foreach ($messages as $message)
68 | 			{
69 | 				$app->enqueueMessage($message, $messageType);
70 | 			}
71 | 		}
72 | 
73 | 		return $this;
74 | 	}
75 | 
76 | 	/**
77 | 	 * Get the system messages generated by this view.
78 | 	 *
79 | 	 * @param   string  $type  Optional type selector
80 | 	 *
81 | 	 * @return  array
82 | 	 */
83 | 	public function getMessages($type = null)
84 | 	{
85 | 		return $type && isset($this->messages[$type]) ? $this->messages[$type] : $this->messages;
86 | 	}
87 | }
88 | 


--------------------------------------------------------------------------------
/src/Traits/HasRedirect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Joomla\CMS\Uri\Uri;
15 | use Joomla\CMS\Router\Route;
16 | 
17 | /**
18 |  * Trait for classes with redirections.
19 |  *
20 |  * @since  1.0.1
21 |  */
22 | trait HasRedirect
23 | {
24 | 	/**
25 | 	 * URL to redirect.
26 | 	 *
27 | 	 * @var   string
28 | 	 */
29 | 	protected $redirectUrl;
30 | 
31 | 	/**
32 | 	 * Get the default redirect url.
33 | 	 *
34 | 	 * @param   boolean  $route  Process URL with Route?
35 | 	 *
36 | 	 * @return  string
37 | 	 */
38 | 	protected function defaultRedirectUrl($route = true)
39 | 	{
40 | 		return Uri::root();
41 | 	}
42 | 
43 | 	/**
44 | 	 * Check if there is a redirection set.
45 | 	 *
46 | 	 * @return  boolean
47 | 	 *
48 | 	 * @since   1.2.0
49 | 	 */
50 | 	public function hasRedirect()
51 | 	{
52 | 		return !empty($this->redirect);
53 | 	}
54 | 
55 | 	/**
56 | 	 * Redirect to the URL.
57 | 	 *
58 | 	 * @return  void
59 | 	 *
60 | 	 * @since   1.2.0
61 | 	 */
62 | 	public function redirect()
63 | 	{
64 | 		Factory::getApplication()->redirect($this->redirectUrl);
65 | 	}
66 | 
67 | 	/**
68 | 	 * Retrieve the active redirect url.
69 | 	 *
70 | 	 * @param   boolean  $route  Process URL with Route?
71 | 	 *
72 | 	 * @return  string
73 | 	 */
74 | 	protected function redirectUrl($route = true)
75 | 	{
76 | 		if (null === $this->redirectUrl)
77 | 		{
78 | 			$this->redirectUrl = $this->defaultRedirectUrl();
79 | 		}
80 | 
81 | 		return $route ? Route::_($this->redirectUrl, false) : $this->redirectUrl;
82 | 	}
83 | 
84 | 	/**
85 | 	 * Set the active redirect URL.
86 | 	 *
87 | 	 * @param   string  $url  URL to redirect the user
88 | 	 *
89 | 	 * @return  self
90 | 	 */
91 | 	public function setRedirectUrl($url)
92 | 	{
93 | 		$this->redirectUrl = $url;
94 | 
95 | 		return $this;
96 | 	}
97 | }
98 | 


--------------------------------------------------------------------------------
/src/Translation/Contracts/Translatable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Translation\Contracts;
10 | 
11 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
12 | 
13 | defined('_JEXEC') || die;
14 | 
15 | /**
16 |  * Describes methods required by translatable entities.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | interface Translatable extends EntityInterface
21 | {
22 | 	/**
23 | 	 * Get a translation.
24 | 	 *
25 | 	 * @param   string  $langTag  Language string. Example: es-ES
26 | 	 *
27 | 	 * @return  static
28 | 	 *
29 | 	 * @throws  \InvalidArgumentException
30 | 	 */
31 | 	public function translation($langTag);
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Translation/Contracts/Translator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Translation\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Describes methods required by translatable entities.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | interface Translator
19 | {
20 | 	/**
21 | 	 * Translate a column.
22 | 	 *
23 | 	 * @param   string  $column   Column to translate
24 | 	 * @param   mixed   $default  Default value
25 | 	 *
26 | 	 * @return  mixed
27 | 	 */
28 | 	public function translate($column, $default = null);
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Translation/TranslatorWithFallback.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Translation;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Represents a collection of entities.
15 |  *
16 |  * @since   1.0.0
17 |  */
18 | class TranslatorWithFallback extends Translator
19 | {
20 | 	/**
21 | 	 * Translate a column.
22 | 	 *
23 | 	 * @param   string  $column   Column to translate
24 | 	 * @param   mixed   $default  Default value
25 | 	 *
26 | 	 * @return  mixed
27 | 	 */
28 | 	public function translate($column, $default = null)
29 | 	{
30 | 		$value = $this->isEntityLanguage() ? $this->entity->get($column) : $this->translation()->get($column);
31 | 
32 | 		if ($this->validator()->isValidColumnValue($column, $value))
33 | 		{
34 | 			return $value;
35 | 		}
36 | 
37 | 		if ($this->isEntityLanguage())
38 | 		{
39 | 			return $default;
40 | 		}
41 | 
42 | 		$value = $this->entity->get($column);
43 | 
44 | 		$isValid = $this->validator()->isValidColumnValue($column, $value);
45 | 
46 | 		return $isValid ? $value : $default;
47 | 	}
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Users/AuthorUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
14 | use Phproberto\Joomla\Entity\Users\RegisteredUserGroup;
15 | 
16 | /**
17 |  * AuthorUserGroup entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class AuthorUserGroup extends PredefinedUserGroup
22 | {
23 | 	/**
24 | 	 * Group title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Author';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'parent_id' => RegisteredUserGroup::instanceOrCreate()->id(),
39 | 			'title'     => self::TITLE
40 | 		];
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Users/Column.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Columns supported by users.
15 |  *
16 |  * @since   1.0.0
17 |  */
18 | abstract class Column
19 | {
20 | 	/**
21 | 	 * Default column used to store author.
22 | 	 *
23 | 	 * @const
24 | 	 */
25 | 	const AUTHOR = 'created_by';
26 | 
27 | 	/**
28 | 	 * Default column used to store editor.
29 | 	 *
30 | 	 * @const
31 | 	 */
32 | 	const EDITOR = 'modified_by';
33 | 
34 | 	/**
35 | 	 * Default column used to store owner.
36 | 	 *
37 | 	 * @const
38 | 	 */
39 | 	const OWNER = 'created_by';
40 | 
41 | 	/**
42 | 	 * Default column used to store user.
43 | 	 *
44 | 	 * @const
45 | 	 */
46 | 	const USER = 'user_id';
47 | }
48 | 


--------------------------------------------------------------------------------
/src/Users/Command/CreatePredefinedUserGroups.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Users\UserGroup;
15 | use Phproberto\Joomla\Entity\Command\BaseCommand;
16 | use Phproberto\Joomla\Entity\Users\GuestUserGroup;
17 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
18 | use Phproberto\Joomla\Entity\Users\RegisteredUserGroup;
19 | use Phproberto\Joomla\Entity\Users\SuperUsersUserGroup;
20 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
21 | 
22 | /**
23 |  * Create the predefined user groups.
24 |  *
25 |  * @since  __DEPLOY_VERSION__
26 |  */
27 | class CreatePredefinedUserGroups extends BaseCommand implements CommandInterface
28 | {
29 | 	/**
30 | 	 * Execute the command.
31 | 	 *
32 | 	 * @return  UserGroup[]
33 | 	 */
34 | 	public function execute()
35 | 	{
36 | 		return [
37 | 			'public'      => PublicUserGroup::create(),
38 | 			'guest'       => GuestUserGroup::create(),
39 | 			'registered'  => RegisteredUserGroup::create(),
40 | 			'super-users' => SuperUsersUserGroup::create()
41 | 		];
42 | 	}
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Users/Command/CreatePredefinedViewLevels.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Command;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Joomla\CMS\Factory;
14 | use Phproberto\Joomla\Entity\Command\BaseCommand;
15 | use Phproberto\Joomla\Entity\Users\GuestViewLevel;
16 | use Phproberto\Joomla\Entity\Users\PublicViewLevel;
17 | use Phproberto\Joomla\Entity\Users\SpecialViewLevel;
18 | use Phproberto\Joomla\Entity\Users\RegisteredViewLevel;
19 | use Phproberto\Joomla\Entity\Users\SuperUsersViewLevel;
20 | use Phproberto\Joomla\Entity\Command\Contracts\CommandInterface;
21 | 
22 | /**
23 |  * Create the predefined user groups.
24 |  *
25 |  * @since  __DEPLOY_VERSION__
26 |  */
27 | class CreatePredefinedViewLevels extends BaseCommand implements CommandInterface
28 | {
29 | 	/**
30 | 	 * Execute the command.
31 | 	 *
32 | 	 * @return  UserGroup[]
33 | 	 */
34 | 	public function execute()
35 | 	{
36 | 		return [
37 | 			'public'      => PublicViewLevel::create(),
38 | 			'registered'  => RegisteredViewLevel::create(),
39 | 			'special'     => SpecialViewLevel::create(),
40 | 			'guest'       => GuestViewLevel::create(),
41 | 			'super-users' => SuperUsersViewLevel::create()
42 | 		];
43 | 	}
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Users/Contracts/Ownerable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\User;
14 | 
15 | /**
16 |  * Describes methods required by entities with an owner.
17 |  *
18 |  * @since  1.0.0
19 |  */
20 | interface Ownerable
21 | {
22 | 	/**
23 | 	 * Get the owner of this entity.
24 | 	 *
25 | 	 * @return  User
26 | 	 */
27 | 	public function owner();
28 | 
29 | 	/**
30 | 	 * Check if this entit has an owner.
31 | 	 *
32 | 	 * @return  boolean
33 | 	 */
34 | 	public function hasOwner();
35 | 
36 | 	/**
37 | 	 * Check if an user is this entity owner.
38 | 	 *
39 | 	 * @param   User  $user  User to check for ownership. Defaults to active user.
40 | 	 *
41 | 	 * @return  boolean
42 | 	 */
43 | 	public function isOwner(User $user = null);
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Users/GuestUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
15 | 
16 | /**
17 |  * User Group entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class GuestUserGroup extends PredefinedUserGroup
22 | {
23 | 	/**
24 | 	 * Group title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Guest';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'parent_id' => PublicUserGroup::instanceOrCreate()->id(),
39 | 			'title'     => self::TITLE
40 | 		];
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Users/GuestViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\GuestUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedViewLevel;
15 | 
16 | /**
17 |  * GuestViewLevel entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class GuestViewLevel extends PredefinedViewLevel
22 | {
23 | 	/**
24 | 	 * View level title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Guest';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'title' => self::TITLE,
39 | 			'rules' => json_encode(
40 | 				[
41 | 					GuestUserGroup::instanceOrCreate()->id()
42 | 				]
43 | 			)
44 | 		];
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Users/ManagerUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
15 | 
16 | /**
17 |  * ManagerUserGroup entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class ManagerUserGroup extends PredefinedUserGroup
22 | {
23 | 	/**
24 | 	 * Group title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Manager';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'parent_id' => PublicUserGroup::instanceOrCreate()->id(),
39 | 			'title'     => self::TITLE
40 | 		];
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Users/PredefinedViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\ViewLevel;
14 | 
15 | /**
16 |  * PredefinedViewLevel entity.
17 |  *
18 |  * @since   __DEPLOY_VERSION__
19 |  */
20 | abstract class PredefinedViewLevel extends ViewLevel
21 | {
22 | 	/**
23 | 	 * Predefined data to load the group.
24 | 	 *
25 | 	 * @return  array
26 | 	 */
27 | 	abstract public static function predefinedData();
28 | 
29 | 	/**
30 | 	 * Constructor
31 | 	 */
32 | 	public function __construct()
33 | 	{
34 | 		$data = static::predefinedData();
35 | 
36 | 		$viewLevel = ViewLevel::loadFromData($data);
37 | 
38 | 		if (!$viewLevel->isLoaded())
39 | 		{
40 | 			throw new \RuntimeException('Cannot find view level: ' . json_encode($data));
41 | 		}
42 | 
43 | 		$this->id = $viewLevel->id();
44 | 		$this->bind($viewLevel->all());
45 | 	}
46 | 
47 | 	/**
48 | 	 * Create the view level.
49 | 	 *
50 | 	 * @param   array|\stdClass  $data  Data to store
51 | 	 *
52 | 	 * @return  static
53 | 	 */
54 | 	public static function create($data = null)
55 | 	{
56 | 		ViewLevel::create(static::predefinedData());
57 | 
58 | 		return static::instance();
59 | 	}
60 | 
61 | 	/**
62 | 	 * Retrieve the cached instance.
63 | 	 *
64 | 	 * @return  static
65 | 	 */
66 | 	public static function instance()
67 | 	{
68 | 		$viewLevel = new static;
69 | 
70 | 		return static::find($viewLevel->id());
71 | 	}
72 | 
73 | 	/**
74 | 	 * Retrieve the view level if exists or create it on the fly.
75 | 	 *
76 | 	 * @return  static
77 | 	 *
78 | 	 * @throws  \RuntimeException
79 | 	 */
80 | 	public static function instanceOrCreate()
81 | 	{
82 | 		try
83 | 		{
84 | 			return static::instance();
85 | 		}
86 | 		catch (\Exception $e)
87 | 		{
88 | 			return static::create();
89 | 		}
90 | 	}
91 | }
92 | 


--------------------------------------------------------------------------------
/src/Users/PublicUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
14 | 
15 | /**
16 |  * User Group entity.
17 |  *
18 |  * @since   __DEPLOY_VERSION__
19 |  */
20 | class PublicUserGroup extends PredefinedUserGroup
21 | {
22 | 	/**
23 | 	 * Parent group identifier.
24 | 	 *
25 | 	 * @const
26 | 	 */
27 | 	const PARENT_ID = 0;
28 | 
29 | 	/**
30 | 	 * Predefined data to load the group.
31 | 	 *
32 | 	 * @return  array
33 | 	 */
34 | 	public static function predefinedData()
35 | 	{
36 | 		return [
37 | 			'parent_id' => self::PARENT_ID
38 | 		];
39 | 	}
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Users/PublicViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedViewLevel;
15 | 
16 | /**
17 |  * PublicViewLevel entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class PublicViewLevel extends PredefinedViewLevel
22 | {
23 | 	/**
24 | 	 * View level title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Public';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'title' => self::TITLE,
39 | 			'rules' => json_encode(
40 | 				[
41 | 					PublicUserGroup::instanceOrCreate()->id()
42 | 				]
43 | 			)
44 | 		];
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Users/RegisteredUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
15 | 
16 | /**
17 |  * RegisteredUserGroup entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class RegisteredUserGroup extends PredefinedUserGroup
22 | {
23 | 	/**
24 | 	 * Group title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Registered';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'parent_id' => PublicUserGroup::instanceOrCreate()->id(),
39 | 			'title'     => self::TITLE
40 | 		];
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Users/RegisteredViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\ManagerUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedViewLevel;
15 | use Phproberto\Joomla\Entity\Users\RegisteredUserGroup;
16 | use Phproberto\Joomla\Entity\Users\SuperUsersUserGroup;
17 | 
18 | /**
19 |  * RegisteredViewLevel entity.
20 |  *
21 |  * @since   __DEPLOY_VERSION__
22 |  */
23 | class RegisteredViewLevel extends PredefinedViewLevel
24 | {
25 | 	/**
26 | 	 * View level title.
27 | 	 *
28 | 	 * @const
29 | 	 */
30 | 	const TITLE = 'Registered';
31 | 
32 | 	/**
33 | 	 * Predefined data to load the group.
34 | 	 *
35 | 	 * @return  array
36 | 	 */
37 | 	public static function predefinedData()
38 | 	{
39 | 		return [
40 | 			'title' => self::TITLE,
41 | 			'rules' => json_encode(
42 | 				[
43 | 					RegisteredUserGroup::instanceOrCreate()->id(),
44 | 					ManagerUserGroup::instanceOrCreate()->id(),
45 | 					SuperUsersUserGroup::instanceOrCreate()->id()
46 | 				]
47 | 			)
48 | 		];
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Users/SpecialViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\AuthorUserGroup;
14 | use Phproberto\Joomla\Entity\Users\ManagerUserGroup;
15 | use Phproberto\Joomla\Entity\Users\PredefinedViewLevel;
16 | use Phproberto\Joomla\Entity\Users\SuperUsersUserGroup;
17 | 
18 | /**
19 |  * SpecialViewLevel entity.
20 |  *
21 |  * @since   __DEPLOY_VERSION__
22 |  */
23 | class SpecialViewLevel extends PredefinedViewLevel
24 | {
25 | 	/**
26 | 	 * View level title.
27 | 	 *
28 | 	 * @const
29 | 	 */
30 | 	const TITLE = 'Special';
31 | 
32 | 	/**
33 | 	 * Predefined data to load the group.
34 | 	 *
35 | 	 * @return  array
36 | 	 */
37 | 	public static function predefinedData()
38 | 	{
39 | 		return [
40 | 			'title' => self::TITLE,
41 | 			'rules' => json_encode(
42 | 				[
43 | 					AuthorUserGroup::instanceOrCreate()->id(),
44 | 					ManagerUserGroup::instanceOrCreate()->id(),
45 | 					SuperUsersUserGroup::instanceOrCreate()->id()
46 | 				]
47 | 			)
48 | 		];
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Users/SuperUsersUserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\PublicUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedUserGroup;
15 | 
16 | /**
17 |  * SuperUsersUserGroup entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class SuperUsersUserGroup extends PredefinedUserGroup
22 | {
23 | 	/**
24 | 	 * Group title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Super Users';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'parent_id' => PublicUserGroup::instanceOrCreate()->id(),
39 | 			'title'     => self::TITLE
40 | 		];
41 | 	}
42 | }
43 | 


--------------------------------------------------------------------------------
/src/Users/SuperUsersViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Users\SuperUsersUserGroup;
14 | use Phproberto\Joomla\Entity\Users\PredefinedViewLevel;
15 | 
16 | /**
17 |  * SuperUsersViewLevel entity.
18 |  *
19 |  * @since   __DEPLOY_VERSION__
20 |  */
21 | class SuperUsersViewLevel extends PredefinedViewLevel
22 | {
23 | 	/**
24 | 	 * View level title.
25 | 	 *
26 | 	 * @const
27 | 	 */
28 | 	const TITLE = 'Super Users';
29 | 
30 | 	/**
31 | 	 * Predefined data to load the group.
32 | 	 *
33 | 	 * @return  array
34 | 	 */
35 | 	public static function predefinedData()
36 | 	{
37 | 		return [
38 | 			'title' => self::TITLE,
39 | 			'rules' => json_encode(
40 | 				[
41 | 					SuperUsersUserGroup::instanceOrCreate()->id()
42 | 				]
43 | 			)
44 | 		];
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Users/Traits/HasUserGroups.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Trait for entities that have associated user groups.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | trait HasUserGroups
19 | {
20 | 	/**
21 | 	 * Associated user groups.
22 | 	 *
23 | 	 * @var  Collection
24 | 	 */
25 | 	protected $userGroups;
26 | 
27 | 	/**
28 | 	 * Clear already loaded userGroups.
29 | 	 *
30 | 	 * @return  self
31 | 	 */
32 | 	public function clearUserGroups()
33 | 	{
34 | 		$this->userGroups = null;
35 | 
36 | 		return $this;
37 | 	}
38 | 
39 | 	/**
40 | 	 * Get the associated user groups.
41 | 	 *
42 | 	 * @return  Collection
43 | 	 */
44 | 	public function userGroups()
45 | 	{
46 | 		if (null === $this->userGroups)
47 | 		{
48 | 			$this->userGroups = $this->loadUserGroups();
49 | 		}
50 | 
51 | 		return $this->userGroups;
52 | 	}
53 | 
54 | 	/**
55 | 	 * Check if this entity has an associated user group.
56 | 	 *
57 | 	 * @param   integer   $id  User identifier
58 | 	 *
59 | 	 * @return  boolean
60 | 	 */
61 | 	public function hasUserGroup($id)
62 | 	{
63 | 		return $this->userGroups()->has($id);
64 | 	}
65 | 
66 | 	/**
67 | 	 * Check if this entity has associated user groups.
68 | 	 *
69 | 	 * @return  boolean
70 | 	 */
71 | 	public function hasUserGroups()
72 | 	{
73 | 		return !$this->userGroups()->isEmpty();
74 | 	}
75 | 
76 | 	/**
77 | 	 * Load associated user groups from DB.
78 | 	 *
79 | 	 * @return  Collection
80 | 	 */
81 | 	abstract protected function loadUserGroups();
82 | }
83 | 


--------------------------------------------------------------------------------
/src/Users/Traits/HasUsers.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Trait for entities that have associated users.
15 |  *
16 |  * @since  1.0.0
17 |  */
18 | trait HasUsers
19 | {
20 | 	/**
21 | 	 * Associated users.
22 | 	 *
23 | 	 * @var  Collection
24 | 	 */
25 | 	protected $users;
26 | 
27 | 	/**
28 | 	 * Clear already loaded users.
29 | 	 *
30 | 	 * @return  self
31 | 	 */
32 | 	public function clearUsers()
33 | 	{
34 | 		$this->users = null;
35 | 
36 | 		return $this;
37 | 	}
38 | 
39 | 	/**
40 | 	 * Get the associated users.
41 | 	 *
42 | 	 * @return  Collection
43 | 	 */
44 | 	public function users()
45 | 	{
46 | 		if (null === $this->users)
47 | 		{
48 | 			$this->users = $this->loadUsers();
49 | 		}
50 | 
51 | 		return $this->users;
52 | 	}
53 | 
54 | 	/**
55 | 	 * Check if this entity has an associated user.
56 | 	 *
57 | 	 * @param   integer   $id  User identifier
58 | 	 *
59 | 	 * @return  boolean
60 | 	 */
61 | 	public function hasUser($id)
62 | 	{
63 | 		return $this->users()->has($id);
64 | 	}
65 | 
66 | 	/**
67 | 	 * Check if this entity has associated users.
68 | 	 *
69 | 	 * @return  boolean
70 | 	 */
71 | 	public function hasUsers()
72 | 	{
73 | 		return !$this->users()->isEmpty();
74 | 	}
75 | 
76 | 	/**
77 | 	 * Load associated users from DB.
78 | 	 *
79 | 	 * @return  Collection
80 | 	 */
81 | 	abstract protected function loadUsers();
82 | }
83 | 


--------------------------------------------------------------------------------
/src/Users/Traits/HasViewLevels.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | /**
14 |  * Trait for entities that have associated view levels.
15 |  *
16 |  * @since  1.2.0
17 |  */
18 | trait HasViewLevels
19 | {
20 | 	/**
21 | 	 * Associated view levels.
22 | 	 *
23 | 	 * @var  Collection
24 | 	 */
25 | 	protected $viewLevels;
26 | 
27 | 	/**
28 | 	 * Clear already loaded view levels.
29 | 	 *
30 | 	 * @return  self
31 | 	 */
32 | 	public function clearViewLevels()
33 | 	{
34 | 		$this->viewLevels = null;
35 | 
36 | 		return $this;
37 | 	}
38 | 
39 | 	/**
40 | 	 * Get the associated view levels.
41 | 	 *
42 | 	 * @return  Collection
43 | 	 */
44 | 	public function viewLevels()
45 | 	{
46 | 		if (null === $this->viewLevels)
47 | 		{
48 | 			$this->viewLevels = $this->loadViewLevels();
49 | 		}
50 | 
51 | 		return $this->viewLevels;
52 | 	}
53 | 
54 | 	/**
55 | 	 * Check if this entity has an associated view level.
56 | 	 *
57 | 	 * @param   integer   $id  View level identifier
58 | 	 *
59 | 	 * @return  boolean
60 | 	 */
61 | 	public function hasViewLevel($id)
62 | 	{
63 | 		return $this->viewLevels()->has($id);
64 | 	}
65 | 
66 | 	/**
67 | 	 * Check if this entity has associated view levels.
68 | 	 *
69 | 	 * @return  boolean
70 | 	 */
71 | 	public function hasViewLevels()
72 | 	{
73 | 		return !$this->viewLevels()->isEmpty();
74 | 	}
75 | 
76 | 	/**
77 | 	 * Load associated view levels.
78 | 	 *
79 | 	 * @return  Collection
80 | 	 */
81 | 	abstract protected function loadViewLevels();
82 | }
83 | 


--------------------------------------------------------------------------------
/src/Users/UserGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\Users\User;
15 | use Phproberto\Joomla\Entity\ComponentEntity;
16 | use Phproberto\Joomla\Entity\Users\Traits\HasUsers;
17 | 
18 | /**
19 |  * User Group entity.
20 |  *
21 |  * @since   1.0.0
22 |  */
23 | class UserGroup extends ComponentEntity
24 | {
25 | 	use HasUsers;
26 | 
27 | 	/**
28 | 	 * Load associated users from DB.
29 | 	 *
30 | 	 * @return  Collection
31 | 	 */
32 | 	protected function loadUsers()
33 | 	{
34 | 		if (!$this->hasId())
35 | 		{
36 | 			return new Collection;
37 | 		}
38 | 
39 | 		$users = array_map(
40 | 			function ($item)
41 | 			{
42 | 				return User::find($item->id)->bind($item);
43 | 			},
44 | 			$this->usersModel()->getItems() ?: array()
45 | 		);
46 | 
47 | 		return new Collection($users);
48 | 	}
49 | 
50 | 	/**
51 | 	 * Get a table instance. Defauts to \JTableUser.
52 | 	 *
53 | 	 * @param   string  $name     Table name. Optional.
54 | 	 * @param   string  $prefix   Class prefix. Optional.
55 | 	 * @param   array   $options  Configuration array for the table. Optional.
56 | 	 *
57 | 	 * @return  \JTable
58 | 	 *
59 | 	 * @throws  \InvalidArgumentException
60 | 	 */
61 | 	public function table($name = '', $prefix = null, $options = array())
62 | 	{
63 | 		$name   = $name ?: 'Usergroup';
64 | 		$prefix = $prefix ?: 'JTable';
65 | 
66 | 		return parent::table($name, $prefix, $options);
67 | 	}
68 | 
69 | 	/**
70 | 	 * Get an instance of the users model.
71 | 	 *
72 | 	 * @return  \UsersModelUsersModel
73 | 	 */
74 | 	protected function usersModel()
75 | 	{
76 | 		\JModelLegacy::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_users/models', 'UsersModel');
77 | 
78 | 		$model = \JModelLegacy::getInstance('Users', 'UsersModel', array('ignore_request' => true));
79 | 
80 | 		if ($this->hasId())
81 | 		{
82 | 			$model->setState('filter.group_id', $this->id());
83 | 		}
84 | 
85 | 		return $model;
86 | 	}
87 | }
88 | 


--------------------------------------------------------------------------------
/src/Users/ViewLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Users;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Collection;
14 | use Phproberto\Joomla\Entity\ComponentEntity;
15 | use Phproberto\Joomla\Entity\Users\Traits\HasUserGroups;
16 | 
17 | /**
18 |  * ViewLevel entity.
19 |  *
20 |  * @since   1.2.0
21 |  */
22 | class ViewLevel extends ComponentEntity
23 | {
24 | 	use HasUserGroups;
25 | 
26 | 	/**
27 | 	 * Get a table instance. Defauts to \JTableUser.
28 | 	 *
29 | 	 * @param   string  $name     Table name. Optional.
30 | 	 * @param   string  $prefix   Class prefix. Optional.
31 | 	 * @param   array   $options  Configuration array for the table. Optional.
32 | 	 *
33 | 	 * @return  \JTable
34 | 	 *
35 | 	 * @throws  \InvalidArgumentException
36 | 	 */
37 | 	public function table($name = '', $prefix = null, $options = array())
38 | 	{
39 | 		$name   = $name ?: 'ViewLevel';
40 | 		$prefix = $prefix ?: 'JTable';
41 | 
42 | 		return parent::table($name, $prefix, $options);
43 | 	}
44 | 
45 | 	/**
46 | 	 * Load associated user groups from DB.
47 | 	 *
48 | 	 * @return  Collection
49 | 	 */
50 | 	protected function loadUserGroups()
51 | 	{
52 | 		$userGroups = new Collection;
53 | 
54 | 		if (!$this->has('rules'))
55 | 		{
56 | 			return $userGroups;
57 | 		}
58 | 
59 | 		$rules = $this->get('rules');
60 | 		$ids = array_unique(
61 | 			array_filter(
62 | 				empty($rules) ? [] : json_decode($rules)
63 | 			)
64 | 		);
65 | 
66 | 		foreach ($ids as $id)
67 | 		{
68 | 			$userGroups->add(UserGroup::find($id));
69 | 		}
70 | 
71 | 		return $userGroups;
72 | 	}
73 | }
74 | 


--------------------------------------------------------------------------------
/src/Validation/Contracts/Rule.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
14 | 
15 | /**
16 |  * Rule requirements.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | interface Rule
21 | {
22 | 	/**
23 | 	 * Id of this rule.
24 | 	 *
25 | 	 * @return  string
26 | 	 */
27 | 	public function id();
28 | 
29 | 	/**
30 | 	 * Name of this rule.
31 | 	 *
32 | 	 * @return  string
33 | 	 */
34 | 	public function name();
35 | 
36 | 	/**
37 | 	 * Check if a value is valid.
38 | 	 *
39 | 	 * @param   mixed  $value  Value to check
40 | 	 *
41 | 	 * @return  boolean
42 | 	 */
43 | 	public function passes($value);
44 | 
45 | 	/**
46 | 	 * Check if a value is not valid.
47 | 	 *
48 | 	 * @param   mixed  $value  Value to check
49 | 	 *
50 | 	 * @return  boolean
51 | 	 */
52 | 	public function fails($value);
53 | }
54 | 


--------------------------------------------------------------------------------
/src/Validation/Contracts/Validable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
14 | 
15 | /**
16 |  * Validable entities requirements.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | interface Validable
21 | {
22 | 	/**
23 | 	 * Check if this entity is valid.
24 | 	 *
25 | 	 * @return  boolean
26 | 	 */
27 | 	public function isValid();
28 | 
29 | 	/**
30 | 	 * Validate this entity.
31 | 	 *
32 | 	 * @return  boolean
33 | 	 *
34 | 	 * @throws  ValidationException
35 | 	 */
36 | 	public function validate();
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Validation/Contracts/Validator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Contracts;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
14 | 
15 | /**
16 |  * Validator requirements.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | interface Validator
21 | {
22 | 	/**
23 | 	 * Validate entity.
24 | 	 *
25 | 	 * @return  boolean
26 | 	 *
27 | 	 * @throws  ValidationException
28 | 	 */
29 | 	public function validate();
30 | 
31 | 	/**
32 | 	 * Validate a column value.
33 | 	 *
34 | 	 * @param   string  $column  Column to check value against.
35 | 	 * @param   mixed   $value   Value for the column.
36 | 	 *
37 | 	 * @return  boolean
38 | 	 *
39 | 	 * @throws  ValidationException
40 | 	 */
41 | 	public function validateColumnValue($column, $value);
42 | 
43 | 	/**
44 | 	 * Check if the entity is valid.
45 | 	 *
46 | 	 * @return  boolean
47 | 	 */
48 | 	public function isValid();
49 | 
50 | 	/**
51 | 	 * Check if a value is valid for a specific column.
52 | 	 *
53 | 	 * @param   string  $column  Column to validate against
54 | 	 * @param   mixed   $value   Value to check
55 | 	 *
56 | 	 * @return  boolean
57 | 	 */
58 | 	public function isValidColumnValue($column, $value);
59 | }
60 | 


--------------------------------------------------------------------------------
/src/Validation/Exception/ValidationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Exception;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
14 | use Phproberto\Joomla\Entity\Contracts\EntityInterface;
15 | use Phproberto\Joomla\Entity\Contracts\ExceptionInterface;
16 | 
17 | /**
18 |  * Validation errors.
19 |  *
20 |  * @since  1.0.0
21 |  */
22 | class ValidationException extends \RuntimeException implements ExceptionInterface
23 | {
24 | 	/**
25 | 	 * Entity did not pass validation.
26 | 	 *
27 | 	 * @param   EntityInterface  $entity  Entity with empty data
28 | 	 * @param   array            $errors  Validation errors
29 | 	 *
30 | 	 * @return  static
31 | 	 */
32 | 	public static function invalidEntity(EntityInterface $entity, array $errors = array())
33 | 	{
34 | 		$entityName = $entity->name() . ($entity->hasId() ? '::' . $entity->id() : null);
35 | 		$msg = sprintf("`%s` is not valid:</br>* ", $entityName);
36 | 
37 | 		if (count($errors))
38 | 		{
39 | 			$msg .= implode("</br>* ", $errors);
40 | 		}
41 | 
42 | 		return new static($msg, 500);
43 | 	}
44 | 
45 | 	/**
46 | 	 * Entity did not pass validation.
47 | 	 *
48 | 	 * @param   string          $column       Entity with empty data
49 | 	 * @param   RuleContract[]  $failedRules  Rule failed
50 | 	 *
51 | 	 * @return  static
52 | 	 */
53 | 	public static function invalidColumn($column, array $failedRules)
54 | 	{
55 | 		$errors = array();
56 | 
57 | 		foreach ($failedRules as $rule)
58 | 		{
59 | 			$errors[] = sprintf("`%s` does not pass `%s` validation rule", $column, $rule->name());
60 | 		}
61 | 
62 | 		return new static(implode("</br>* ", $errors), 500);
63 | 	}
64 | }
65 | 


--------------------------------------------------------------------------------
/src/Validation/Rule.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Decorator;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Validator as ValidatorContract;
15 | 
16 | /**
17 |  * Entity validator.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | abstract class Rule
22 | {
23 | 	/**
24 | 	 * Id of this rule.
25 | 	 *
26 | 	 * @var  string
27 | 	 */
28 | 	protected $id;
29 | 
30 | 	/**
31 | 	 * Name of this rule.
32 | 	 *
33 | 	 * @var  string
34 | 	 */
35 | 	protected $name;
36 | 
37 | 	/**
38 | 	 * Constructor
39 | 	 *
40 | 	 * @param   mixed  $name  Name of this rule
41 | 	 */
42 | 	public function __construct($name = null)
43 | 	{
44 | 		$this->name = $name;
45 | 	}
46 | 
47 | 	/**
48 | 	 * Check if a value is not valid.
49 | 	 *
50 | 	 * @param   mixed  $value  Value to check
51 | 	 *
52 | 	 * @return  boolean
53 | 	 */
54 | 	public function fails($value)
55 | 	{
56 | 		return !$this->passes($value);
57 | 	}
58 | 
59 | 	/**
60 | 	 * Id of this rule.
61 | 	 *
62 | 	 * @return  string
63 | 	 */
64 | 	public function id()
65 | 	{
66 | 		if (null === $this->id)
67 | 		{
68 | 			$this->id = spl_object_hash($this);
69 | 		}
70 | 
71 | 		return $this->id;
72 | 	}
73 | 
74 | 	/**
75 | 	 * Name of this rule.
76 | 	 *
77 | 	 * @return  string
78 | 	 */
79 | 	public function name()
80 | 	{
81 | 		return null === $this->name ? get_class($this) : \JText::_($this->name);
82 | 	}
83 | }
84 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/CustomRule.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Custom validation rule.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class CustomRule extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * String to search for.
25 | 	 *
26 | 	 * @var  callable
27 | 	 */
28 | 	protected $validator;
29 | 
30 | 	/**
31 | 	 * Constructor
32 | 	 *
33 | 	 * @param   callable  $validator  Closure to execute
34 | 	 * @param   mixed     $name       Name of this rule
35 | 	 */
36 | 	public function __construct(callable $validator, $name = null)
37 | 	{
38 | 		parent::__construct($name);
39 | 
40 | 		$this->validator = $validator;
41 | 	}
42 | 
43 | 	/**
44 | 	 * Check if a value is valid.
45 | 	 *
46 | 	 * @param   mixed  $value  Value to check
47 | 	 *
48 | 	 * @return  boolean
49 | 	 */
50 | 	public function passes($value)
51 | 	{
52 | 		return call_user_func_array($this->validator, array($value));
53 | 	}
54 | }
55 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsEmptyDate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a date is empty.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsEmptyDate extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return in_array($value, array(null, '', $this->nullDate()));
33 | 	}
34 | 
35 | 	/**
36 | 	 * Get the empty date for the active DB driver.
37 | 	 *
38 | 	 * @return  string
39 | 	 *
40 | 	 * @codeCoverageIgnore
41 | 	 */
42 | 	protected function nullDate()
43 | 	{
44 | 		return \JFactory::getDbo()->getNullDate();
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsEmptyString.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a string is empty.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsEmptyString extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		if (in_array($value, array('', null), true))
33 | 		{
34 | 			return true;
35 | 		}
36 | 
37 | 		return '' === trim((string) $value);
38 | 	}
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that value is an integer.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsInteger extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return is_numeric($value) && $value == (int) $value;
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNegativeInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule\IsInteger;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that value is a negative integer.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsNegativeInteger extends IsInteger implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return parent::passes($value) && (int) $value < 0;
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNotEmptyDate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
14 | 
15 | /**
16 |  * Check that a date is not empty.
17 |  *
18 |  * @since   1.0.0
19 |  */
20 | class IsNotEmptyDate extends IsEmptyDate implements RuleContract
21 | {
22 | 	/**
23 | 	 * Check if a value is valid.
24 | 	 *
25 | 	 * @param   mixed  $value  Value to check
26 | 	 *
27 | 	 * @return  boolean
28 | 	 */
29 | 	public function passes($value)
30 | 	{
31 | 		return !parent::passes($value);
32 | 	}
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNotEmptyString.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule\IsEmptyString;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that value is not an empty string.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsNotEmptyString extends IsEmptyString implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return !parent::passes($value);
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNotNull.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule\IsNull;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a column is not null.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsNotNull extends IsNull implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return !parent::passes($value);
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNull.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a column is null.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsNull extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return (null === $value);
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNullOrEmptyString.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Rule\IsNull;
15 | use Phproberto\Joomla\Entity\Validation\Rule\IsEmptyString;
16 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
17 | 
18 | /**
19 |  * Check that a column is null or an empty string.
20 |  *
21 |  * @since   1.0.0
22 |  */
23 | class IsNullOrEmptyString extends Rule implements RuleContract
24 | {
25 | 	/**
26 | 	 * Check if a value is valid.
27 | 	 *
28 | 	 * @param   mixed  $value  Value to check
29 | 	 *
30 | 	 * @return  boolean
31 | 	 */
32 | 	public function passes($value)
33 | 	{
34 | 		$isNullValidator = new IsNull;
35 | 		$emptyStringValidator = new IsEmptyString;
36 | 
37 | 		return $isNullValidator->passes($value) || $emptyStringValidator->passes($value);
38 | 	}
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsNullOrPositiveInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
15 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
16 | 
17 | /**
18 |  * Check that value is null or a positve integer.
19 |  *
20 |  * @since   1.7.0
21 |  */
22 | class IsNullOrPositiveInteger extends Rule implements RuleContract
23 | {
24 | 	/**
25 | 	 * Check if a value is valid.
26 | 	 *
27 | 	 * @param   mixed  $value  Value to check
28 | 	 *
29 | 	 * @return  boolean
30 | 	 */
31 | 	public function passes($value)
32 | 	{
33 | 		$isNullRule = new IsNull($this->name);
34 | 
35 | 		if ($isNullRule->passes($value))
36 | 		{
37 | 			return true;
38 | 		}
39 | 
40 | 		$isPositiveIntegerRule = new IsPositiveInteger($this->name);
41 | 
42 | 		return $isPositiveIntegerRule->passes($value);
43 | 	}
44 | }
45 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsPositiveInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule\IsInteger;
14 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
15 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
16 | 
17 | /**
18 |  * Check that value is a positive integer.
19 |  *
20 |  * @since   1.0.0
21 |  */
22 | class IsPositiveInteger extends IsInteger implements RuleContract
23 | {
24 | 	/**
25 | 	 * Check if a value is valid.
26 | 	 *
27 | 	 * @param   mixed  $value  Value to check
28 | 	 *
29 | 	 * @return  boolean
30 | 	 */
31 | 	public function passes($value)
32 | 	{
33 | 		return parent::passes($value) && (int) $value > 0;
34 | 	}
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsString.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a value is a string.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class IsString extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return is_string($value);
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/IsZeroOrPositiveInteger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule\IsInteger;
14 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
15 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
16 | 
17 | /**
18 |  * Check that value is zero or a positve integer.
19 |  *
20 |  * @since   1.7.0
21 |  */
22 | class IsZeroOrPositiveInteger extends IsInteger implements RuleContract
23 | {
24 | 	/**
25 | 	 * Check if a value is valid.
26 | 	 *
27 | 	 * @param   mixed  $value  Value to check
28 | 	 *
29 | 	 * @return  boolean
30 | 	 */
31 | 	public function passes($value)
32 | 	{
33 | 		if (!parent::passes($value))
34 | 		{
35 | 			return false;
36 | 		}
37 | 
38 | 		return  (int) $value > 0 || (int) $value === 0;
39 | 	}
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/NoSubstrCount.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a string is not present in another string.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class NoSubstrCount extends SubstrCount
22 | {
23 | 	/**
24 | 	 * Check if a value is valid.
25 | 	 *
26 | 	 * @param   mixed  $value  Value to check
27 | 	 *
28 | 	 * @return  boolean
29 | 	 */
30 | 	public function passes($value)
31 | 	{
32 | 		return !parent::passes($value);
33 | 	}
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Validation/Rule/SubstrCount.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Rule;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Rule;
14 | use Phproberto\Joomla\Entity\Validation\Contracts\Rule as RuleContract;
15 | 
16 | /**
17 |  * Check that a string is present in another string.
18 |  *
19 |  * @since   1.0.0
20 |  */
21 | class SubstrCount extends Rule implements RuleContract
22 | {
23 | 	/**
24 | 	 * String to search for.
25 | 	 *
26 | 	 * @var  string
27 | 	 */
28 | 	protected $substr;
29 | 
30 | 	/**
31 | 	 * Constructor
32 | 	 *
33 | 	 * @param   string  $substr  String to search for
34 | 	 * @param   mixed   $name    Name of this rule
35 | 	 */
36 | 	public function __construct($substr, $name = null)
37 | 	{
38 | 		parent::__construct($name);
39 | 
40 | 		$this->substr = $substr;
41 | 	}
42 | 
43 | 	/**
44 | 	 * Check if a value is valid.
45 | 	 *
46 | 	 * @param   mixed  $value  Value to check
47 | 	 *
48 | 	 * @return  boolean
49 | 	 */
50 | 	public function passes($value)
51 | 	{
52 | 		return substr_count($value, $this->substr) > 0;
53 | 	}
54 | }
55 | 


--------------------------------------------------------------------------------
/src/Validation/Traits/HasValidation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Joomla! entity library.
 4 |  *
 5 |  * @copyright  Copyright (C) 2017-2019 Roberto Segura López, Inc. All rights reserved.
 6 |  * @license    See COPYING.txt
 7 |  */
 8 | 
 9 | namespace Phproberto\Joomla\Entity\Validation\Traits;
10 | 
11 | defined('_JEXEC') || die;
12 | 
13 | use Phproberto\Joomla\Entity\Validation\Validator;
14 | use Phproberto\Joomla\Entity\Validation\Exception\ValidationException;
15 | use Phproberto\Joomla\Entity\Validation\Contracts\Validator as ValidatorContract;
16 | 
17 | /**
18 |  * Trait for entities with validation.
19 |  *
20 |  * @since   1.0.0
21 |  */
22 | trait HasValidation
23 | {
24 | 	/**
25 | 	 * Associated validator.
26 | 	 *
27 | 	 * @var  ValidatorContract
28 | 	 */
29 | 	protected $validator;
30 | 
31 | 	/**
32 | 	 * Check if this entity is valid.
33 | 	 *
34 | 	 * @return  boolean
35 | 	 */
36 | 	public function isValid()
37 | 	{
38 | 		return $this->validator()->isValid();
39 | 	}
40 | 
41 | 	/**
42 | 	 * Set validator.
43 | 	 *
44 | 	 * @param   ValidatorContract  $validator  Validator to use
45 | 	 *
46 | 	 * @return  self
47 | 	 */
48 | 	public function setValidator(ValidatorContract $validator)
49 | 	{
50 | 		$this->validator = $validator;
51 | 
52 | 		return $this;
53 | 	}
54 | 
55 | 	/**
56 | 	 * Retrieve entity validator.
57 | 	 *
58 | 	 * @return  ValidatorContract
59 | 	 */
60 | 	public function validator()
61 | 	{
62 | 		if (null === $this->validator)
63 | 		{
64 | 			$this->validator = new Validator($this);
65 | 		}
66 | 
67 | 		return $this->validator;
68 | 	}
69 | 
70 | 	/**
71 | 	 * Validate this entity.
72 | 	 *
73 | 	 * @return  boolean
74 | 	 *
75 | 	 * @throws  ValidationException
76 | 	 */
77 | 	public function validate()
78 | 	{
79 | 		return $this->validator()->validate();
80 | 	}
81 | }
82 | 


--------------------------------------------------------------------------------