Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Removed some weirdly formatted comments #3552

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions app/code/core/Mage/Admin/Model/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
*/
class Mage_Admin_Model_User extends Mage_Core_Model_Abstract
{
/**#@+
/**
* Configuration paths for email templates and identities
*/
public const XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template';
Expand All @@ -80,7 +80,6 @@ class Mage_Admin_Model_User extends Mage_Core_Model_Abstract
/** Configuration paths for notifications */
public const XML_PATH_ADDITIONAL_EMAILS = 'general/additional_notification_emails/admin_user_create';
public const XML_PATH_NOTIFICATION_EMAILS_TEMPLATE = 'admin/emails/admin_notification_email_template';
/**#@-*/

/**
* Minimum length of admin password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*/
abstract class Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract extends Mage_Adminhtml_Block_Widget
{
/**#@+
/**
* Current massactions
* @var string
*/
Expand Down Expand Up @@ -56,7 +56,6 @@ abstract class Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract extends Mage
public const UNHOLD_ORDER = 'unhold_order';
public const UNSUBSCRIBE = 'unsubscribe';
public const UPDATE_STATUS = 'update_status';
/**#@-*/

/**
* @var string[]
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Helper/Data.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ class Mage_Api2_Helper_Data extends Mage_Core_Helper_Abstract
*/
public const XML_PATH_API2_RESPONSE_RENDERS = 'global/api2/response/renders';

/**#@+
/**
* Config paths
*/
public const XML_PATH_AUTH_ADAPTERS = 'global/api2/auth_adapters';
public const XML_PATH_USER_TYPES = 'global/api2/user_types';
/**#@- */

protected $_moduleName = 'Mage_Api2';

Expand Down
6 changes: 2 additions & 4 deletions app/code/core/Mage/Api2/Model/Acl/Global/Role.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,18 @@
*/
class Mage_Api2_Model_Acl_Global_Role extends Mage_Core_Model_Abstract
{
/**#@+
/**
* System roles identifiers
*/
public const ROLE_GUEST_ID = 1;
public const ROLE_CUSTOMER_ID = 2;
/**#@-*/

/**#@+
/**
* Config node identifiers
*/
public const ROLE_CONFIG_NODE_NAME_GUEST = 'guest';
public const ROLE_CONFIG_NODE_NAME_CUSTOMER = 'customer';
public const ROLE_CONFIG_NODE_NAME_ADMIN = 'admin';
/**#@-*/

/**
* Permissions model
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Model/Acl/Global/Rule/Permission.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@
*/
class Mage_Api2_Model_Acl_Global_Rule_Permission
{
/**#@+
/**
* Source keys
*/
public const TYPE_ALLOW = 1;
public const TYPE_DENY = 0;
/**#@-*/

/**
* Get options parameters
Expand Down
6 changes: 2 additions & 4 deletions app/code/core/Mage/Api2/Model/Acl/Global/Rule/Tree.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@
*/
class Mage_Api2_Model_Acl_Global_Rule_Tree extends Mage_Core_Helper_Abstract
{
/**#@+
/**
* Tree types
*/
public const TYPE_ATTRIBUTE = 'attribute';
public const TYPE_PRIVILEGE = 'privilege';
/**#@-*/

/**#@+
/**
* Names
*/
public const NAME_CHILDREN = 'children';
Expand All @@ -38,7 +37,6 @@ class Mage_Api2_Model_Acl_Global_Rule_Tree extends Mage_Core_Helper_Abstract
public const NAME_RESOURCE = 'resource';
public const NAME_RESOURCE_GROUPS = 'resource_groups';
public const NAME_GROUP = 'group';
/**#@-*/

/**
* Separator for tree ID
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Model/Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Mage_Api2_Model_Request extends Zend_Controller_Request_Http
*/
public const REQUEST_CHARSET = 'utf-8';

/**#@+
/**
* Name of query ($_GET) parameters to use in navigation and so on
*/
public const QUERY_PARAM_REQ_ATTRS = 'attrs';
Expand All @@ -35,7 +35,6 @@ class Mage_Api2_Model_Request extends Zend_Controller_Request_Http
public const QUERY_PARAM_ORDER_FIELD = 'order';
public const QUERY_PARAM_ORDER_DIR = 'dir';
public const QUERY_PARAM_FILTER = 'filter';
/**#@- */

/**
* Interpreter adapter
Expand Down
21 changes: 7 additions & 14 deletions app/code/core/Mage/Api2/Model/Resource.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,30 +30,27 @@
*/
abstract class Mage_Api2_Model_Resource
{
/**#@+
/**
* Action types
*/
public const ACTION_TYPE_ENTITY = 'entity';
public const ACTION_TYPE_COLLECTION = 'collection';
/**#@-*/

/**#@+
/**
* Operations. Resource method names
*/
public const OPERATION_CREATE = 'create';
public const OPERATION_RETRIEVE = 'retrieve';
public const OPERATION_UPDATE = 'update';
public const OPERATION_DELETE = 'delete';
/**#@-*/

/**#@+
/**
* Common operations for attributes
*/
public const OPERATION_ATTRIBUTE_READ = 'read';
public const OPERATION_ATTRIBUTE_WRITE = 'write';
/**#@-*/

/**#@+
/**
* Default error messages
*/
public const RESOURCE_NOT_FOUND = 'Resource not found.';
Expand All @@ -64,30 +61,26 @@ abstract class Mage_Api2_Model_Resource
public const RESOURCE_DATA_INVALID = 'Resource data invalid.'; //error while checking data inside method
public const RESOURCE_UNKNOWN_ERROR = 'Resource unknown error.';
public const RESOURCE_REQUEST_DATA_INVALID = 'The request data is invalid.';
/**#@-*/

/**#@+
/**
* Default collection resources error messages
*/
public const RESOURCE_COLLECTION_PAGING_ERROR = 'Resource collection paging error.';
public const RESOURCE_COLLECTION_PAGING_LIMIT_ERROR = 'The paging limit exceeds the allowed number.';
public const RESOURCE_COLLECTION_ORDERING_ERROR = 'Resource collection ordering error.';
public const RESOURCE_COLLECTION_FILTERING_ERROR = 'Resource collection filtering error.';
public const RESOURCE_COLLECTION_ATTRIBUTES_ERROR = 'Resource collection including additional attributes error.';
/**#@-*/

/**#@+
/**
* Default success messages
*/
public const RESOURCE_UPDATED_SUCCESSFUL = 'Resource updated successful.';
/**#@-*/

/**#@+
/**
* Collection page sizes
*/
public const PAGE_SIZE_DEFAULT = 10;
public const PAGE_SIZE_MAX = 100;
/**#@-*/

/**
* Request
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Model/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,12 @@ class Mage_Api2_Model_Response extends Zend_Controller_Response_Http
*/
public const RESPONSE_CHARSET = 'utf-8';

/**#@+
/**
* Default message types
*/
public const MESSAGE_TYPE_SUCCESS = 'success';
public const MESSAGE_TYPE_ERROR = 'error';
public const MESSAGE_TYPE_WARNING = 'warning';
/**#@- */

/**
* Messages
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Model/Route/Abstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,14 @@
*/
abstract class Mage_Api2_Model_Route_Abstract extends Zend_Controller_Router_Route
{
/**#@+
/**
* Names for Zend_Controller_Router_Route::__construct params
*/
public const PARAM_ROUTE = 'route';
public const PARAM_DEFAULTS = 'defaults';
public const PARAM_REQS = 'reqs';
public const PARAM_TRANSLATOR = 'translator';
public const PARAM_LOCALE = 'locale';
/**#@- */

/**
* Default values of parent::__construct() params
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Api2/Model/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Mage_Api2_Model_Server
*/
public const API_TYPE_REST = 'rest';

/**#@+
/**
* HTTP Response Codes
*/
public const HTTP_OK = 200;
Expand All @@ -39,7 +39,6 @@ class Mage_Api2_Model_Server
public const HTTP_METHOD_NOT_ALLOWED = 405;
public const HTTP_NOT_ACCEPTABLE = 406;
public const HTTP_INTERNAL_ERROR = 500;
/**#@- */

/**
* List of api types
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Core/Helper/Url/Rewrite.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@
*/
class Mage_Core_Helper_Url_Rewrite extends Mage_Core_Helper_Abstract
{
/**#@+
/**
* Validation error constants
*/
public const VERR_MANYSLASHES = 1; // Too many slashes in a row of request path, e.g. '///foo//'
public const VERR_ANCHOR = 2; // Anchor is not supported in request path, e.g. 'foo#bar'
/**#@-*/

/**
* Allowed request path length
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Core/Model/Store.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class Mage_Core_Model_Store extends Mage_Core_Model_Abstract
*/
public const ENTITY = 'core_store';

/**#@+
/**
* Configuration pathes
* @var string
*/
Expand All @@ -72,7 +72,6 @@ class Mage_Core_Model_Store extends Mage_Core_Model_Abstract
public const XML_PATH_SECURE_IN_ADMINHTML = 'web/secure/use_in_adminhtml';
public const XML_PATH_OFFLOADER_HEADER = 'web/secure/offloader_header';
public const XML_PATH_PRICE_SCOPE = 'catalog/price/scope';
/**#@-*/

/**
* Price scope constants
Expand Down
3 changes: 1 addition & 2 deletions app/code/core/Mage/Core/Model/Url/Validator.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@
*/
class Mage_Core_Model_Url_Validator extends Zend_Validate_Abstract
{
/**#@+
/**
* Error keys
*/
public const INVALID_URL = 'invalidUrl';
/**#@-*/

/**
* Object constructor
Expand Down
11 changes: 4 additions & 7 deletions app/code/core/Mage/Customer/Model/Customer.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@
*/
class Mage_Customer_Model_Customer extends Mage_Core_Model_Abstract
{
/**#@+
* Configuration pathes for email templates and identities
/**
* Configuration paths for email templates and identities
*/
public const XML_PATH_REGISTER_EMAIL_TEMPLATE = 'customer/create_account/email_template';
public const XML_PATH_REGISTER_EMAIL_IDENTITY = 'customer/create_account/email_identity';
Expand All @@ -122,24 +122,21 @@ class Mage_Customer_Model_Customer extends Mage_Core_Model_Abstract
public const XML_PATH_GENERATE_HUMAN_FRIENDLY_ID = 'customer/create_account/generate_human_friendly_id';
public const XML_PATH_CHANGED_PASSWORD_OR_EMAIL_TEMPLATE = 'customer/changed_account/password_or_email_template';
public const XML_PATH_CHANGED_PASSWORD_OR_EMAIL_IDENTITY = 'customer/changed_account/password_or_email_identity';
/**#@-*/

/**#@+
/**
* Codes of exceptions related to customer model
*/
public const EXCEPTION_EMAIL_NOT_CONFIRMED = 1;
public const EXCEPTION_INVALID_EMAIL_OR_PASSWORD = 2;
public const EXCEPTION_EMAIL_EXISTS = 3;
public const EXCEPTION_INVALID_RESET_PASSWORD_LINK_TOKEN = 4;
public const EXCEPTION_INVALID_RESET_PASSWORD_LINK_CUSTOMER_ID = 5;
/**#@-*/

/**#@+
/**
* Subscriptions
*/
public const SUBSCRIBED_YES = 'yes';
public const SUBSCRIBED_NO = 'no';
/**#@-*/

public const CACHE_TAG = 'customer';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ class Mage_ImportExport_Model_Import_Entity_Product extends Mage_ImportExport_Mo
* Null Scope
*/
public const SCOPE_NULL = -1;
/**#@-*/

/**#@+
/**
* Permanent column names.
*
* Names that begins with underscore is not an attribute. This name convention is for
Expand Down Expand Up @@ -89,9 +88,8 @@ class Mage_ImportExport_Model_Import_Entity_Product extends Mage_ImportExport_Mo
* Col Sku
*/
public const COL_SKU = 'sku';
/**#@-*/

/**#@+
/**
* Error codes.
*/
public const ERROR_INVALID_SCOPE = 'invalidScope';
Expand Down Expand Up @@ -220,7 +218,6 @@ class Mage_ImportExport_Model_Import_Entity_Product extends Mage_ImportExport_Mo
* Error - invalid product sku
*/
public const ERROR_INVALID_PRODUCT_SKU = 'invalidSku';
/**#@-*/

/**
* Pairs of attribute set ID-to-name.
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Install/Model/Installer/Filesystem.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/
class Mage_Install_Model_Installer_Filesystem extends Mage_Install_Model_Installer_Abstract
{
/**#@+
/**
* @deprecated since 1.7.1.0
*/
public const MODE_WRITE = 'write';
Expand Down
9 changes: 3 additions & 6 deletions app/code/core/Mage/Oauth/Helper/Data.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/
class Mage_Oauth_Helper_Data extends Mage_Core_Helper_Abstract
{
/**#@+
/**
* Endpoint types with appropriate routes
*/
public const ENDPOINT_AUTHORIZE_CUSTOMER = 'oauth/authorize';
Expand All @@ -30,19 +30,16 @@ class Mage_Oauth_Helper_Data extends Mage_Core_Helper_Abstract
public const ENDPOINT_AUTHORIZE_ADMIN_SIMPLE = 'adminhtml/oauth_authorize/simple';
public const ENDPOINT_INITIATE = 'oauth/initiate';
public const ENDPOINT_TOKEN = 'oauth/token';
/**#@-*/

/**#@+
/**
* Cleanup xpath config settings
*/
public const XML_PATH_CLEANUP_PROBABILITY = 'oauth/cleanup/cleanup_probability';
public const XML_PATH_CLEANUP_EXPIRATION_PERIOD = 'oauth/cleanup/expiration_period';
/**#@-*/

/**#@+ Email template */
/** Email template */
public const XML_PATH_EMAIL_TEMPLATE = 'oauth/email/template';
public const XML_PATH_EMAIL_IDENTITY = 'oauth/email/identity';
/**#@-*/

/**
* Cleanup expiration period in minutes
Expand Down
Loading
Loading