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.

Sign up for GitHub

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

Use native iterators for Phalcon\Validation\Message\Group #1657

Merged
merged 2 commits into from Dec 9, 2013
Merged

Use native iterators for Phalcon\Validation\Message\Group #1657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbe6d24
Use native iterators for Phalcon\Validation\Message\Group
sjinks Dec 9, 2013
c55ac8f
Test case
sjinks Dec 9, 2013
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
103 changes: 103 additions & 0 deletions ext/tests/issue-1657.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
--TEST--
Use native iterators for Phalcon\Validation\Message\Group - https://github.com/phalcon/cphalcon/pull/1657
--SKIPIF--
<?php include('skipif.inc'); ?>
--FILE--
<?php

class MyGroup extends \Phalcon\Validation\Message\Group
{
public function rewind()
{
echo __METHOD__, PHP_EOL;
return parent::rewind();
}

public function valid()
{
echo __METHOD__, PHP_EOL;
return parent::valid();
}

public function current()
{
echo __METHOD__, PHP_EOL;
return parent::current();
}

public function next()
{
echo __METHOD__, PHP_EOL;
return parent::next();
}
}

$messages = array(
new \Phalcon\Validation\Message("Message 1"),
new \Phalcon\Validation\Message("Message 2"),
new \Phalcon\Validation\Message("Message 3"),
);

$group = new \Phalcon\Validation\Message\Group($messages);
// Native Iterator Interface is used here
foreach ($group as $msg) {
var_dump($msg->getMessage());
}

// Class methods are used here
$group->rewind();
while ($group->valid()) {
$msg = $group->current();
var_dump($msg->getMessage());
$group->next();
}

// Inherited class - userspace methods are invoked
$group = new \MyGroup($messages);
foreach ($group as $msg) {
var_dump($msg->getMessage());
}

// Inherited class - userspace methods are invoked
$group->rewind();
while ($group->valid()) {
$msg = $group->current();
var_dump($msg->getMessage());
$group->next();
}
?>
--EXPECT--
string(9) "Message 1"
string(9) "Message 2"
string(9) "Message 3"
string(9) "Message 1"
string(9) "Message 2"
string(9) "Message 3"
MyGroup::rewind
MyGroup::valid
MyGroup::current
string(9) "Message 1"
MyGroup::next
MyGroup::valid
MyGroup::current
string(9) "Message 2"
MyGroup::next
MyGroup::valid
MyGroup::current
string(9) "Message 3"
MyGroup::next
MyGroup::valid
MyGroup::rewind
MyGroup::valid
MyGroup::current
string(9) "Message 1"
MyGroup::next
MyGroup::valid
MyGroup::current
string(9) "Message 2"
MyGroup::next
MyGroup::valid
MyGroup::current
string(9) "Message 3"
MyGroup::next
MyGroup::valid
185 changes: 142 additions & 43 deletions ext/validation/message/group.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

#include "kernel/main.h"
#include "kernel/memory.h"

#include "kernel/hash.h"
#include "kernel/object.h"
#include "kernel/array.h"
#include "kernel/exception.h"
Expand All @@ -44,6 +44,90 @@
* Represents a group of validation messages
*/

static void phalcon_validation_message_group_dtor(zend_object_iterator *it TSRMLS_DC)
{
zval_ptr_dtor((zval**)&it->data);
efree(it);
}

static int phalcon_validation_message_group_valid(zend_object_iterator *it TSRMLS_DC)
{
zval *position, *messages;

position = phalcon_fetch_nproperty_this((zval*)it->data, SL("_position"), PH_NOISY TSRMLS_CC);
messages = phalcon_fetch_nproperty_this((zval*)it->data, SL("_messages"), PH_NOISY TSRMLS_CC);
if (phalcon_array_isset(messages, position)) {
return SUCCESS;
}

return FAILURE;
}

static void phalcon_validation_message_group_get_current_data(zend_object_iterator *it, zval ***data TSRMLS_DC)
{
zval *position, *messages;

position = phalcon_fetch_nproperty_this((zval*)it->data, SL("_position"), PH_NOISY_CC);
messages = phalcon_fetch_nproperty_this((zval*)it->data, SL("_messages"), PH_NOISY_CC);

*data = phalcon_hash_get(Z_ARRVAL_P(messages), position, BP_VAR_NA);
}

#if ZEND_MODULE_API_NO >= 20121212
static void phalcon_validation_message_group_get_current_key(zend_object_iterator *it, zval *key TSRMLS_DC)
{
zval *position;

position = phalcon_fetch_nproperty_this((zval*)it->data, SL("_position"), PH_NOISY_CC);
ZVAL_ZVAL(key, position, 1, 0);
}
#else
static int phalcon_validation_message_group_get_current_key(zend_object_iterator *it, char **str_key, uint *str_key_len, ulong *int_key TSRMLS_DC)
{
zval *position;

position = phalcon_fetch_nproperty_this((zval*)it->data, SL("_position"), PH_NOISY_CC);
*int_key = (IS_LONG == Z_TYPE_P(position)) ? Z_LVAL_P(position) : phalcon_get_intval(position);
return HASH_KEY_IS_LONG;
}
#endif

static void phalcon_validation_message_group_move_forward(zend_object_iterator *it TSRMLS_DC)
{
phalcon_property_incr((zval*)it->data, SL("_position") TSRMLS_CC);
}

static void phalcon_validation_message_group_rewind(zend_object_iterator *it TSRMLS_DC)
{
phalcon_update_property_long((zval*)it->data, SL("_position"), 0 TSRMLS_CC);
}

static zend_object_iterator_funcs phalcon_validation_message_group_iterator_funcs = {
phalcon_validation_message_group_dtor,
phalcon_validation_message_group_valid,
phalcon_validation_message_group_get_current_data,
phalcon_validation_message_group_get_current_key,
phalcon_validation_message_group_move_forward,
phalcon_validation_message_group_rewind
};

static zend_object_iterator* phalcon_validation_message_group_get_iterator(zend_class_entry *ce, zval *object, int by_ref TSRMLS_DC)
{
zend_object_iterator *result;

if (by_ref) {
zend_throw_exception_ex(phalcon_validation_exception_ce, 0 TSRMLS_CC, "Cannot iterate Phalcon\\Validation\\Message\\Group by reference");
return NULL;
}

result = emalloc(sizeof(zend_object_iterator));

Z_ADDREF_P(object);
result->data = object;
result->funcs = &phalcon_validation_message_group_iterator_funcs;

return result;
}

/**
* Phalcon\Validation\Message\Group initializer
Expand All @@ -55,6 +139,9 @@ PHALCON_INIT_CLASS(Phalcon_Validation_Message_Group){
zend_declare_property_null(phalcon_validation_message_group_ce, SL("_position"), ZEND_ACC_PROTECTED TSRMLS_CC);
zend_declare_property_null(phalcon_validation_message_group_ce, SL("_messages"), ZEND_ACC_PROTECTED TSRMLS_CC);

phalcon_validation_message_group_ce->get_iterator = phalcon_validation_message_group_get_iterator;
phalcon_validation_message_group_ce->iterator_funcs.funcs = &phalcon_validation_message_group_iterator_funcs;

zend_class_implements(phalcon_validation_message_group_ce TSRMLS_CC, 3, spl_ce_Countable, zend_ce_arrayaccess, zend_ce_iterator);

return SUCCESS;
Expand Down Expand Up @@ -212,8 +299,6 @@ PHP_METHOD(Phalcon_Validation_Message_Group, appendMessage){
PHP_METHOD(Phalcon_Validation_Message_Group, appendMessages){

zval *messages, *current_messages, *final_messages = NULL;
zval *message = NULL;
zval *r0 = NULL;

PHALCON_MM_GROW();

Expand Down Expand Up @@ -241,25 +326,35 @@ PHP_METHOD(Phalcon_Validation_Message_Group, appendMessages){
}
phalcon_update_property_this(this_ptr, SL("_messages"), final_messages TSRMLS_CC);
} else {
zend_class_entry *ce = Z_OBJCE_P(messages);
zend_object_iterator *it = ce->get_iterator(ce, messages, 0 TSRMLS_CC);

PHALCON_VERIFY_INTERFACE_EX(messages, zend_ce_iterator, phalcon_validation_exception_ce, 1);

assert(it != NULL);
assert(it->funcs->rewind != NULL);
assert(it->funcs->valid != NULL);
assert(it->funcs->get_current_data != NULL);
assert(it->funcs->move_forward != NULL);

/**
* A group of messages is iterated and appended one-by-one to the current list
*/
phalcon_call_method_noret(messages, "rewind");
it->funcs->rewind(it TSRMLS_CC);
while (!EG(exception) && SUCCESS == it->funcs->valid(it TSRMLS_CC)) {
zval **message;

while (1) {

PHALCON_INIT_NVAR(r0);
phalcon_call_method(r0, messages, "valid");
if (PHALCON_IS_NOT_FALSE(r0)) {
} else {
break;
it->funcs->get_current_data(it, &message TSRMLS_CC);
if (!EG(exception)) {
phalcon_call_method_params(NULL, NULL, this_ptr, SL("appendmessage"), zend_inline_hash_func(SS("appendmessage")) TSRMLS_CC, 1, *message);
}

if (!EG(exception)) {
it->funcs->move_forward(it TSRMLS_CC);
}

PHALCON_INIT_NVAR(message);
phalcon_call_method(message, messages, "current");
phalcon_call_method_p1_noret(this_ptr, "appendmessage", message);
phalcon_call_method_noret(messages, "next");
}

it->funcs->dtor(it TSRMLS_CC);
}

PHALCON_MM_RESTORE();
Expand Down Expand Up @@ -341,9 +436,9 @@ PHP_METHOD(Phalcon_Validation_Message_Group, count){
*/
PHP_METHOD(Phalcon_Validation_Message_Group, rewind){


phalcon_update_property_long(this_ptr, SL("_position"), 0 TSRMLS_CC);

zend_object_iterator it;
it.data = getThis();
phalcon_validation_message_group_iterator_funcs.rewind(&it TSRMLS_CC);
}

/**
Expand All @@ -353,14 +448,15 @@ PHP_METHOD(Phalcon_Validation_Message_Group, rewind){
*/
PHP_METHOD(Phalcon_Validation_Message_Group, current){

zval *position, *messages, *message;
zval **ret;
zend_object_iterator it;
it.data = getThis();

position = phalcon_fetch_nproperty_this(this_ptr, SL("_position"), PH_NOISY_CC);
messages = phalcon_fetch_nproperty_this(this_ptr, SL("_messages"), PH_NOISY_CC);
if (phalcon_array_isset_fetch(&message, messages, position)) {
RETURN_ZVAL(message, 1, 0);
phalcon_validation_message_group_iterator_funcs.get_current_data(&it, &ret TSRMLS_CC);
if (ret) {
RETURN_ZVAL(*ret, 1, 0);
}

RETURN_NULL();
}

Expand All @@ -371,8 +467,22 @@ PHP_METHOD(Phalcon_Validation_Message_Group, current){
*/
PHP_METHOD(Phalcon_Validation_Message_Group, key){

zend_object_iterator it;
it.data = getThis();
#if ZEND_MODULE_API_NO >= 20121212
phalcon_validation_message_group_iterator_funcs.get_current_key(&it, return_value TSRMLS_CC);
#else
{
char *str_key;
uint str_key_len;
ulong int_key;
if (HASH_KEY_IS_STRING == phalcon_validation_message_group_iterator_funcs.get_current_key(&it, &str_key, &str_key_len, &int_key TSRMLS_CC)) {
RETURN_STRINGL(str_key, str_key_len-1, 1);
}

RETURN_MEMBER(this_ptr, "_position");
RETURN_LONG(int_key);
}
#endif
}

/**
Expand All @@ -381,9 +491,9 @@ PHP_METHOD(Phalcon_Validation_Message_Group, key){
*/
PHP_METHOD(Phalcon_Validation_Message_Group, next){


phalcon_property_incr(this_ptr, SL("_position") TSRMLS_CC);

zend_object_iterator it;
it.data = getThis();
phalcon_validation_message_group_iterator_funcs.move_forward(&it TSRMLS_CC);
}

/**
Expand All @@ -393,20 +503,9 @@ PHP_METHOD(Phalcon_Validation_Message_Group, next){
*/
PHP_METHOD(Phalcon_Validation_Message_Group, valid){

zval *position, *messages;

PHALCON_MM_GROW();

PHALCON_OBS_VAR(position);
phalcon_read_property_this(&position, this_ptr, SL("_position"), PH_NOISY_CC);

PHALCON_OBS_VAR(messages);
phalcon_read_property_this(&messages, this_ptr, SL("_messages"), PH_NOISY_CC);
if (phalcon_array_isset(messages, position)) {
RETURN_MM_TRUE;
}

RETURN_MM_FALSE;
zend_object_iterator it;
it.data = getThis();
RETURN_BOOL(phalcon_validation_message_group_iterator_funcs.valid(&it TSRMLS_CC) == SUCCESS);
}

/**
Expand Down